Database | discojs

Hierarchy

Database
- Discojs

Index

Database Methods

deleteReleaseRating

deleteReleaseRating(this: Discojs, releaseId: number): Promise<EmptyResponse>

- Defined in src/database.ts:103
Deletes the release’s rating for the authenticated user.

label

Release Rating

link

https://www.discogs.com/developers#page:database,header:database-release-rating-by-user

Parameters
- this: Discojs
- releaseId: number
Returns Promise<EmptyResponse>

getArtist

getArtist(this: Discojs, artistId: number): Promise<{} & {} & {} & {}>

- Defined in src/database.ts:172
Get an artist.

label

Artist

link

https://www.discogs.com/developers#page:database,header:database-artist

Parameters
- this: Discojs
- artistId: number
Returns Promise<{} & {} & {} & {}>

getArtistReleases

getArtistReleases(this: Discojs, artistId: number, sort?: SortOptions<ReleaseSortEnum>, pagination?: Pagination): Promise<{}>

- Defined in src/database.ts:184
Returns a list of releases and masters associated with an artist.

label

Artist Releases

link

https://www.discogs.com/developers#page:database,header:database-artist-releases

Parameters
- this: Discojs
- artistId: number
- Optional sort: SortOptions<ReleaseSortEnum>
- Optional pagination: Pagination
Returns Promise<{}>

getCommunityReleaseRating

getCommunityReleaseRating(this: Discojs, releaseId: number): Promise<{}>

- Defined in src/database.ts:116
Retrieves the community release rating average and count.

label

Community Release Rating

link

https://www.discogs.com/developers#page:database,header:database-community-release-rating

Parameters
- this: Discojs
- releaseId: number
Returns Promise<{}>

getLabel

getLabel(this: Discojs, labelId: number): Promise<{} & {} & {}>

- Defined in src/database.ts:204
Get a label.

label

Label

link

https://www.discogs.com/developers#page:database,header:database-label

Parameters
- this: Discojs
- labelId: number
Returns Promise<{} & {} & {}>

getLabelReleases

getLabelReleases(this: Discojs, labelId: number, pagination?: Pagination): Promise<{}>

- Defined in src/database.ts:216
Returns a list of releases associated with the label.

label

Label Releases

link

https://www.discogs.com/developers#page:database,header:database-all-label-releases

Parameters
- this: Discojs
- labelId: number
- Optional pagination: Pagination
Returns Promise<{}>

getMaster

getMaster(this: Discojs, masterId: number): Promise<{} & {}>

- Defined in src/database.ts:147
Get a master release.

label

Master Release

link

https://www.discogs.com/developers#page:database,header:database-master-release

Parameters
- this: Discojs
- masterId: number
Returns Promise<{} & {}>

getMasterVersions

getMasterVersions(this: Discojs, masterId: number, pagination?: Pagination): Promise<{}>

- Defined in src/database.ts:160
Retrieves a list of all releases that are versions of a master.

label

Master Release Versions

link

https://www.discogs.com/developers#page:database,header:database-master-release-versions

Parameters
- this: Discojs
- masterId: number
- Optional pagination: Pagination
Returns Promise<{}>

getRelease

getRelease(this: Discojs, releaseId: number, currency?: CurrenciesEnum): Promise<{} & {} & {}>

- Defined in src/database.ts:51
Get a release.

label

Release

link

https://www.discogs.com/developers#page:database,header:database-release

Parameters
- this: Discojs
- releaseId: number
- Optional currency: CurrenciesEnum
Returns Promise<{} & {} & {}>

getReleaseRating

getReleaseRating(this: Discojs, releaseId: number): Promise<{}>

- Defined in src/database.ts:75
Retrieves the release’s rating for the authenticated user.

label

Release Rating

link

https://www.discogs.com/developers#page:database,header:database-release-rating-by-user

Parameters
- this: Discojs
- releaseId: number
Returns Promise<{}>

getReleaseRatingForUser

getReleaseRatingForUser(this: Discojs, username: string, releaseId: number): Promise<{}>

- Defined in src/database.ts:63
Retrieves the release’s rating for a given user.

label

Release Rating

link

https://www.discogs.com/developers#page:database,header:database-release-rating-by-user

Parameters
- this: Discojs
- username: string
- releaseId: number
Returns Promise<{}>

getReleaseStats

getReleaseStats(this: Discojs, releaseId: number): Promise<ReleaseStatsResponse>

- Defined in src/database.ts:131
Retrieves the total number of “haves” (in the community’s collections) and “wants” (in the community’s wantlists) for a given release.

label

Release Stats

link

https://www.discogs.com/developers#page:database,header:database-release-stats

Note: This endpoint is broken, see link below for a workaround.

link

https://www.discogs.com/fr/forum/thread/865093?message_id=8630743

Parameters
- this: Discojs
- releaseId: number
Returns Promise<ReleaseStatsResponse>

searchArtist

searchArtist(this: Discojs, query: string, options?: SearchOptions, pagination?: Pagination): Promise<{}>

- Defined in src/database.ts:264
Search for an artist.

label

Search

link

https://www.discogs.com/developers#page:database,header:database-search

Parameters
- this: Discojs
- query: string
- Default value options: SearchOptions = {}
- Optional pagination: Pagination
Returns Promise<{}>

searchDatabase

searchDatabase(this: Discojs, options?: SearchOptions, pagination?: Pagination): Promise<{}>

- Defined in src/database.ts:228
Issue a search query to Discogs database.

label

Search

link

https://www.discogs.com/developers#page:database,header:database-search

Parameters
- this: Discojs
- Default value options: SearchOptions = {}
- Optional pagination: Pagination
Returns Promise<{}>

searchLabel

searchLabel(this: Discojs, query: string, options?: SearchOptions, pagination?: Pagination): Promise<{}>

- Defined in src/database.ts:276
Search for a label.

label

Search

link

https://www.discogs.com/developers#page:database,header:database-search

Parameters
- this: Discojs
- query: string
- Default value options: SearchOptions = {}
- Optional pagination: Pagination
Returns Promise<{}>

searchMaster

searchMaster(this: Discojs, query: string, options?: SearchOptions, pagination?: Pagination): Promise<{}>

- Defined in src/database.ts:252
Search for a master release.

label

Search

link

https://www.discogs.com/developers#page:database,header:database-search

Parameters
- this: Discojs
- query: string
- Default value options: SearchOptions = {}
- Optional pagination: Pagination
Returns Promise<{}>

searchRelease

searchRelease(this: Discojs, query: string, options?: SearchOptions, pagination?: Pagination): Promise<{}>

- Defined in src/database.ts:240
Search for a release.

label

Search

link

https://www.discogs.com/developers#page:database,header:database-search

Parameters
- this: Discojs
- query: string
- Default value options: SearchOptions = {}
- Optional pagination: Pagination
Returns Promise<{}>

updateReleaseRating

updateReleaseRating(this: Discojs, releaseId: number, rating: RatingValues): Promise<{}>

- Defined in src/database.ts:88
Updates the release’s rating for the authenticated user.

label

Release Rating

link

https://www.discogs.com/developers#page:database,header:database-release-rating-by-user

Parameters
- this: Discojs
- releaseId: number
- rating: RatingValues
Returns Promise<{}>

Generated using TypeDoc

Hierarchy

Index

Database Methods

Database Methods

deleteReleaseRating

Parameters

this: Discojs

releaseId: number

Returns Promise<EmptyResponse>

getArtist

Parameters

this: Discojs

artistId: number

Returns Promise<{} & {} & {} & {}>

getArtistReleases

Parameters

this: Discojs

artistId: number

Optional sort: SortOptions<ReleaseSortEnum>

Optional pagination: Pagination

Returns Promise<{}>

getCommunityReleaseRating

Parameters

this: Discojs

releaseId: number

Returns Promise<{}>

getLabel

Parameters

this: Discojs

labelId: number

Returns Promise<{} & {} & {}>

getLabelReleases

Parameters

this: Discojs

labelId: number

Optional pagination: Pagination

Returns Promise<{}>

getMaster

Parameters

this: Discojs

masterId: number

Returns Promise<{} & {}>

getMasterVersions

Parameters

this: Discojs

masterId: number

Optional pagination: Pagination

Returns Promise<{}>

getRelease

Parameters

this: Discojs

releaseId: number

Optional currency: CurrenciesEnum

Returns Promise<{} & {} & {}>

getReleaseRating

Parameters

this: Discojs

releaseId: number

Returns Promise<{}>

getReleaseRatingForUser

Parameters

this: Discojs

username: string

releaseId: number

Returns Promise<{}>

getReleaseStats

Parameters

this: Discojs

releaseId: number

Returns Promise<ReleaseStatsResponse>

searchArtist

Parameters

this: Discojs

query: string

Default value options: SearchOptions = {}

Optional pagination: Pagination

Returns Promise<{}>

searchDatabase

Parameters

this: Discojs