ArtistManager | tspotify

Stores cache for artists and holds their API methods

Hierarchy

BaseManager<ArtistResolvable, Artist>
- ArtistManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ArtistManager(client: Client): ArtistManager

Overrides BaseManager.constructor
- Defined in src/managers/ArtistManager.ts:34
Parameters
- client: Client
Returns ArtistManager

Properties

Protected _holds

_holds: StructureConstructable<Artist>

The type of structure held by this manager

cache

cache: Collection<string, Artist>

The cache of the structures held by this manager

client

client: Client

Client that instantiated this class

Methods

Private _fetchMany

_fetchMany(ids: string[], options?: FetchArtistsOptions): Promise<Collection<string, Artist>>

- Defined in src/managers/ArtistManager.ts:99
Parameters
- ids: string[]
- Optional options: FetchArtistsOptions
Returns Promise<Collection<string, Artist>>

Private _fetchSingle

_fetchSingle(id: string, options?: FetchArtistOptions): Promise<Artist>

- Defined in src/managers/ArtistManager.ts:89
Parameters
- id: string
- Optional options: FetchArtistOptions
Returns Promise<Artist>

Protected _search

_search(options: SearchOptions, type: SearchItemType, market?: string): Promise<GetSearchResponse>

Inherited from BaseManager._search
- Defined in src/managers/BaseManager.ts:79
Searches Spotify

Parameters
- options: SearchOptions
  
  The options for searching
- type: SearchItemType
  
  The type of items to search
- Optional market: string
Returns Promise<GetSearchResponse>

add

add(id: string, cacheAfterFetching?: boolean, data: unknown): Artist

Inherited from BaseManager.add
- Defined in src/managers/BaseManager.ts:68
Converts raw data sent by the API to a structure and adds it to the cache

Parameters
- id: string
  
  The ID of the structure
- cacheAfterFetching: boolean = true
  
  Whether to cache the structure or not
- data: unknown
  
  The raw data returned by the API for this structure
Returns Artist

fetch

fetch<T>(options: T): Promise<null | FetchedArtist<T>>

- Defined in src/managers/ArtistManager.ts:65
Fetches artist(s) from Spotify

Type parameters
- T: ArtistResolvable | FetchArtistOptions | FetchArtistsOptions
Parameters
- options: T
Returns Promise<null | FetchedArtist<T>>

fetchAlbums

fetchAlbums(artist: ArtistResolvable, options?: FetchArtistAlbumsOptions): Promise<Page<SimplifiedAlbumObject, SimplifiedAlbum>>

- Defined in src/managers/ArtistManager.ts:173
Fetches albums of an artist

Parameters
- artist: ArtistResolvable
  
  The artist whose albums are to be fetched
- Optional options: FetchArtistAlbumsOptions
  
  Options for fetching the albums
Returns Promise<Page<SimplifiedAlbumObject, SimplifiedAlbum>>

A Page of SimplifiedAlbum objects as a Promise

fetchRelatedArtist

fetchRelatedArtist(artist: ArtistResolvable): Promise<Collection<string, Artist>>

- Defined in src/managers/ArtistManager.ts:152
Fetches artists similar to a given artist

Parameters
- artist: ArtistResolvable
  
  The artist whose relation are to be fetched
Returns Promise<Collection<string, Artist>>

A collection of Artist objects as a Promise

fetchTopTracks

fetchTopTracks(artist: ArtistResolvable, market: string): Promise<Collection<string, Track>>

- Defined in src/managers/ArtistManager.ts:130
Fetches top ten tracks of an artist from a given market

Parameters
- artist: ArtistResolvable
  
  The artist whose top tracks are to be fetched
- market: string
  
  The market to consider for the top tracks
Returns Promise<Collection<string, Track>>

A collection of Track objects as a Promise

resolve

resolve(artistResolvable: ArtistResolvable): null | Artist

Overrides BaseManager.resolve
- Defined in src/managers/ArtistManager.ts:42
Resolves an ArtistResolvable to an Artist object

Parameters
- artistResolvable: ArtistResolvable
Returns null | Artist

resolveID

resolveID(artistResolvable: ArtistResolvable): null | string

Overrides BaseManager.resolveID
- Defined in src/managers/ArtistManager.ts:53
Resolves an ArtistResolvable to an Artist ID

Parameters
- artistResolvable: ArtistResolvable
Returns null | string

search

search(options: SearchArtistsOptions): Promise<Page<ArtistObject, Artist>>

- Defined in src/managers/ArtistManager.ts:195
Fetches artists from Spotify by searching

Parameters
- options: SearchArtistsOptions
  
  The options provided for searching artists
Returns Promise<Page<ArtistObject, Artist>>

A Page of Artist objects as a Promise

Generated using TypeDoc