EpisodeManager | tspotify

Hierarchy

BaseManager<EpisodeResolvable, Episode>
- EpisodeManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new EpisodeManager(client: Client): EpisodeManager

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

Properties

Protected _holds

_holds: StructureConstructable<Episode>

The type of structure held by this manager

cache

cache: Collection<string, Episode>

The cache of the structures held by this manager

client

client: Client

Client that instantiated this class

Methods

Private _fetchMany

_fetchMany(ids: string[], options: FetchEpisodesOptions): Promise<Collection<string, Episode>>

- Defined in src/managers/EpisodeManager.ts:84
Parameters
- ids: string[]
- options: FetchEpisodesOptions
Returns Promise<Collection<string, Episode>>

Private _fetchSingle

_fetchSingle(id: string, options: FetchEpisodeOptions): Promise<Episode>

- Defined in src/managers/EpisodeManager.ts:70
Parameters
- id: string
- options: FetchEpisodeOptions
Returns Promise<Episode>

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

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 Episode

fetch

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

- Defined in src/managers/EpisodeManager.ts:51
Fetches episode(s) from Spotify

Type parameters
- T: FetchEpisodeOptions | FetchEpisodesOptions
Parameters
- options: T
Returns Promise<null | FetchedEpisode<T>>

resolve

resolve(episodeResolvable: EpisodeResolvable): null | Episode

Overrides BaseManager.resolve
- Defined in src/managers/EpisodeManager.ts:28
Resolves an EpisodeResolvable to an Episode object

Parameters
- episodeResolvable: EpisodeResolvable
Returns null | Episode

resolveID

resolveID(episodeResolvable: EpisodeResolvable): null | string

Overrides BaseManager.resolveID
- Defined in src/managers/EpisodeManager.ts:39
Resolves an EpisodeResolvable to an Episode ID

Parameters
- episodeResolvable: EpisodeResolvable
Returns null | string

search

search(options: SearchEpisodesOptions): Promise<Page<SimplifiedEpisodeObject, SimplifiedEpisode>>

- Defined in src/managers/EpisodeManager.ts:116
Fetches episodes from Spotify by searching

Parameters
- options: SearchEpisodesOptions
  
  The options provided for searching episodes
Returns Promise<Page<SimplifiedEpisodeObject, SimplifiedEpisode>>

A Page of SimplifiedEpisode objects as a Promise

Generated using TypeDoc