AlbumManager | tspotify

Stores cache for albums and holds their API methods

Hierarchy

BaseManager<AlbumResolvable, Album>
- AlbumManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AlbumManager(client: Client): AlbumManager

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

Properties

Protected _holds

_holds: StructureConstructable<Album>

The type of structure held by this manager

cache

cache: Collection<string, Album>

The cache of the structures held by this manager

client

client: Client

Client that instantiated this class

Methods

Private _fetchMany

_fetchMany(ids: string[], options?: FetchAlbumsOptions): Promise<Collection<string, Album>>

- Defined in src/managers/AlbumManager.ts:105
Parameters
- ids: string[]
- Optional options: FetchAlbumsOptions
Returns Promise<Collection<string, Album>>

Private _fetchSingle

_fetchSingle(id: string, options?: FetchAlbumOptions): Promise<Album>

- Defined in src/managers/AlbumManager.ts:92
Parameters
- id: string
- Optional options: FetchAlbumOptions
Returns Promise<Album>

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): Album

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 Album

fetch

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

- Defined in src/managers/AlbumManager.ts:68
Fetches album(s) from Spotify

Type parameters
- T: AlbumResolvable | FetchAlbumOptions | FetchAlbumsOptions
Parameters
- options: T
  
  Options for fetching album(s)
Returns Promise<null | FetchedAlbum<T>>

fetchNewReleases

fetchNewReleases(options?: FetchNewReleasesOptions): Promise<Page<SimplifiedAlbumObject, SimplifiedAlbum>>

- Defined in src/managers/AlbumManager.ts:158
Fetches recently released albums

Parameters
- Optional options: FetchNewReleasesOptions
  
  Options for fetching new releases
Returns Promise<Page<SimplifiedAlbumObject, SimplifiedAlbum>>

A Page of SimplifiedAlbum objects as a Promise

fetchTracks

fetchTracks(album: AlbumResolvable, options?: FetchAlbumTracksOptions): Promise<Page<SimplifiedTrackObject, SimplifiedTrack>>

- Defined in src/managers/AlbumManager.ts:137
Fetches track(s) of an album

Parameters
- album: AlbumResolvable
  
  The album whose tracks are to be fetched
- Optional options: FetchAlbumTracksOptions
  
  Options for fetching the tracks
Returns Promise<Page<SimplifiedTrackObject, SimplifiedTrack>>

A Page of SimplifiedTrack objects as a Promise

resolve

resolve(albumResolvable: AlbumResolvable): null | Album

Overrides BaseManager.resolve
- Defined in src/managers/AlbumManager.ts:44
Resolves an AlbumResolvable to an Album object

Parameters
- albumResolvable: AlbumResolvable
Returns null | Album

resolveID

resolveID(albumResolvable: AlbumResolvable): null | string

Overrides BaseManager.resolveID
- Defined in src/managers/AlbumManager.ts:55
Resolves an AlbumResolvable to an Album ID

Parameters
- albumResolvable: AlbumResolvable
Returns null | string

search

search(options: SearchAlbumsOptions): Promise<Page<SimplifiedAlbumObject, SimplifiedAlbum>>

- Defined in src/managers/AlbumManager.ts:174
Fetches albums from Spotify by searching

Parameters
- options: SearchAlbumsOptions
  
  The options provided for searching albums
Returns Promise<Page<SimplifiedAlbumObject, SimplifiedAlbum>>

A Page of SimplifiedAlbum objects as a Promise

Generated using TypeDoc