ShowManager | tspotify

Hierarchy

BaseManager<ShowResolvable, Show>
- ShowManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ShowManager(client: Client): ShowManager

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

Properties

Protected _holds

_holds: StructureConstructable<Show>

The type of structure held by this manager

cache

cache: Collection<string, Show>

The cache of the structures held by this manager

client

client: Client

Client that instantiated this class

Methods

Private _fetchMany

_fetchMany(ids: string[], options: FetchShowsOptions): Promise<Collection<string, SimplifiedShow>>

- Defined in src/managers/ShowManager.ts:93
⚠️Note: Unlike other bulk endpoints, this one doesn't return a complete object. Since, the object(s) fetched by this method are SimplifiedShow, they aren't cached

Parameters
- ids: string[]
- options: FetchShowsOptions
Returns Promise<Collection<string, SimplifiedShow>>

Private _fetchSingle

_fetchSingle(id: string, options: FetchShowOptions): Promise<Show>

- Defined in src/managers/ShowManager.ts:76
Parameters
- id: string
- options: FetchShowOptions
Returns Promise<Show>

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

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 Show

fetch

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

- Defined in src/managers/ShowManager.ts:56
Type parameters
- T: FetchShowOptions | FetchShowsOptions
Parameters
- options: T
Returns Promise<null | FetchedShow<T>>

fetchEpisodes

fetchEpisodes(show: ShowResolvable, options: FetchShowEpisodesOptions): Promise<Page<SimplifiedEpisodeObject, SimplifiedEpisode>>

- Defined in src/managers/ShowManager.ts:117
Fetches episodes of a show

Parameters
- show: ShowResolvable
  
  The show whose episodes are to be fetched
- options: FetchShowEpisodesOptions
  
  The options for fetching episodes of a show
Returns Promise<Page<SimplifiedEpisodeObject, SimplifiedEpisode>>

A Page of SimplifiedEpisode objects as a Promise

resolve

resolve(showResolvable: ShowResolvable): null | Show

Overrides BaseManager.resolve
- Defined in src/managers/ShowManager.ts:36
Resolves a ShowResolvable to a Show object

Parameters
- showResolvable: ShowResolvable
Returns null | Show

resolveID

resolveID(showResolvable: ShowResolvable): null | string

Overrides BaseManager.resolveID
- Defined in src/managers/ShowManager.ts:47
Resolves a ShowResolvable to a Show ID

Parameters
- showResolvable: ShowResolvable
Returns null | string

search

search(options: SearchShowsOptions): Promise<Page<SimplifiedShowObject, SimplifiedShow>>

- Defined in src/managers/ShowManager.ts:139
Fetches shows from Spotify by searching

Parameters
- options: SearchShowsOptions
  
  The options provided for searching shows
Returns Promise<Page<SimplifiedShowObject, SimplifiedShow>>

A Page of SimplifiedShow objects as a Promise

Generated using TypeDoc