ArtistManager | spotify.js documentation

Hierarchy

Manager
- ArtistManager

Index

Constructors

constructor

Methods

Constructors

constructor

new ArtistManager(config: SpotifyConfig, privateConfig: PrivateConfig): ArtistManager

Inherited from Manager.constructor
- Defined in src/lib/Manager.ts:7
Parameters
- config: SpotifyConfig
- privateConfig: PrivateConfig
Returns ArtistManager

Methods

albums

albums(id: string, options?: PagingOptions & { include?: { album?: boolean; appears_on?: boolean; compilation?: boolean; single?: boolean }; market?: Markets }): Promise<PagingObject<AlbumSimplified>>

- Defined in src/lib/artist/ArtistManager.ts:52
description
Get multiple albums from an artist by ID.

Parameters
- id: string
- Optional options: PagingOptions & { include?: { album?: boolean; appears_on?: boolean; compilation?: boolean; single?: boolean }; market?: Markets }
Returns Promise<PagingObject<AlbumSimplified>>
Returns a promise with an array of Albums.

get

get(id: string): Promise<Artist>

- Defined in src/lib/artist/ArtistManager.ts:18
description
Get a artist by ID.

Parameters
- id: string
Returns Promise<Artist>
Returns a promise with a single Artist.

list

list(ids: string[]): Promise<Artist[]>

- Defined in src/lib/artist/ArtistManager.ts:29
description
Get multiple artists by ID.

Parameters
- ids: string[]
  Array of IDs.
Returns Promise<Artist[]>
Returns a promise with an array of Artists.

related(id: string): Promise<Artist[]>

- Defined in src/lib/artist/ArtistManager.ts:87
description
Get related artists by ID.

Parameters
- id: string
Returns Promise<Artist[]>
Returns a promise with an array of Artists.

topTracks

topTracks(id: string, market?: Markets): Promise<Track[]>

- Defined in src/lib/artist/ArtistManager.ts:102
description
Get top tracks from artist by ID.

Parameters
- id: string
- Optional market: Markets
  An ISO 3166-1 alpha-2 country code. If a country code is specified, only episodes that are available in that market will be returned. If a valid user access token is specified in the request header, the country associated with the user account will take priority over this parameter. Note: If neither market or user country are provided, the content is considered unavailable for the client.
Returns Promise<Track[]>
Returns a promise with an array of Tracks.

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

config: SpotifyConfig

privateConfig: PrivateConfig

Returns ArtistManager

Methods

albums

Parameters

id: string

Optional options: PagingOptions & { include?: { album?: boolean; appears_on?: boolean; compilation?: boolean; single?: boolean }; market?: Markets }

Returns Promise<PagingObject<AlbumSimplified>>

get

Parameters

id: string

Returns Promise<Artist>

list

Parameters

ids: string[]

Returns Promise<Artist[]>

related

Parameters

id: string

Returns Promise<Artist[]>

topTracks

Parameters

id: string

Optional market: Markets

Returns Promise<Track[]>