PlaylistManager | tspotify

Stores cache for playlists and holds their API methods

Hierarchy

BaseManager<PlaylistResolvable, Playlist>
- PlaylistManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PlaylistManager(client: Client): PlaylistManager

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

Properties

Protected _holds

_holds: StructureConstructable<Playlist>

The type of structure held by this manager

cache

cache: Collection<string, Playlist>

The cache of the structures held by this manager

client

client: Client

Client that instantiated this class

Methods

Private _fetchSigle

_fetchSigle(id: string, options: FetchPlaylistOptions): Promise<Playlist>

- Defined in src/managers/PlaylistManager.ts:72
Parameters
- id: string
- options: FetchPlaylistOptions
Returns Promise<Playlist>

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

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 Playlist

fetch

fetch(options: FetchPlaylistOptions): Promise<Playlist>

- Defined in src/managers/PlaylistManager.ts:65
Parameters
- options: FetchPlaylistOptions
Returns Promise<Playlist>

fetchCoverImage

fetchCoverImage(playlist: PlaylistResolvable): Promise<Image[]>

- Defined in src/managers/PlaylistManager.ts:131
Fetches cover image of a playlist

Parameters
- playlist: PlaylistResolvable
  
  The playlist whose cover image is to be fetched
Returns Promise<Image[]>

An array of Image object

fetchFeaturedPlaylists

fetchFeaturedPlaylists(options?: FetchFeaturedPlaylistsOptions): Promise<Page<SimplifiedPlaylistObject, SimplifiedPlaylist>>

- Defined in src/managers/PlaylistManager.ts:148
Fetches playlists that are featured by Spotify

Parameters
- Optional options: FetchFeaturedPlaylistsOptions
  
  Options for fetching the featured playlists
Returns Promise<Page<SimplifiedPlaylistObject, SimplifiedPlaylist>>

A Page of SimplifiedPlaylist objects as a Promise

fetchItems

fetchItems(options: FetchPlaylistItemsOptions): Promise<Page<PlaylistTrackObject, PlaylistTrack>>

- Defined in src/managers/PlaylistManager.ts:112
Fetches items of a playlist

Parameters
- options: FetchPlaylistItemsOptions
  
  Options for fetching items of a playlist
Returns Promise<Page<PlaylistTrackObject, PlaylistTrack>>

A Page of PlaylistTrack objects a Promise

fetchUserPlaylists

fetchUserPlaylists(user: UserResolvable, options?: FetchUserPlaylistsOptions): Promise<Page<SimplifiedPlaylistObject, SimplifiedPlaylist>>

- Defined in src/managers/PlaylistManager.ts:92
Fetches playlists of a user

Parameters
- user: UserResolvable
  
  The user whose playlists are to be fetched
- Optional options: FetchUserPlaylistsOptions
  
  Options for fetching the user's playlists
Returns Promise<Page<SimplifiedPlaylistObject, SimplifiedPlaylist>>

A Page of SimplifiedPlaylist objects as a Promise

resolve

resolve(playlistResolvable: PlaylistResolvable): null | Playlist

Overrides BaseManager.resolve
- Defined in src/managers/PlaylistManager.ts:43
Resolves a PlaylistResolavable to a Playlist

Parameters
- playlistResolvable: PlaylistResolvable
  
  A string or object that can be resolved to a Playlist
Returns null | Playlist

A Playlist

resolveID

resolveID(playlistResolvable: PlaylistResolvable): null | string

Overrides BaseManager.resolveID
- Defined in src/managers/PlaylistManager.ts:56
Resolves a PlaylistResolvable to a Playlist ID

Parameters
- playlistResolvable: PlaylistResolvable
  
  A string or object that can be resolved to a Playlist
Returns null | string

The ID of a Playlist

search

search(options: SearchPlaylistsOptions): Promise<Page<SimplifiedPlaylistObject, SimplifiedPlaylist>>

- Defined in src/managers/PlaylistManager.ts:168
Fetches playlists from Spotify by searching

Parameters
- options: SearchPlaylistsOptions
  
  The options provided for searching playlists
Returns Promise<Page<SimplifiedPlaylistObject, SimplifiedPlaylist>>

A Page of SimplifiedPlaylist objects as a Promise

Generated using TypeDoc