SpotifyApiSpotify LogoJS

EpisodeManager src/managers/Episode.ts#L17

A manager to perform actions which belongs to the spotify episode web api.


Properties:

client

Methods:

get getMultiple search

constructor(client) src/managers/Episode.ts#L17

No documentation found.

NameTypeDescription
clientClientThe spotify api client.

.client

Type:

Client

No documentation found.

.get(id, market, force) src/managers/Episode.ts#L49

Get an episode's information.

const episode = await client.episodes.get('id');

Returns:

Promise<"null" | Episode>

Parameters:

NameTypeDescription
idstringThe spotify episode id.
marketstringOnly episodes that are available in that market will be returned.
forcebooleanWhen true, will directly fetch else will search for the cache first!

.getMultiple(ids, market) src/managers/Episode.ts#L62

Get the information of multiple spotify episodes in one fetch.

const episodes = await client.episodes.getMultiple(['id1', 'id2']);

Returns:

Promise<Episode[]>

Parameters:

NameTypeDescription
idsstring[]An array of spotify ids.
marketstringOnly episodes that are available in that market will be returned.

.search(query, options) src/managers/Episode.ts#L26

Search for spotify episodes with query.

const results = await client.episodes.search('some search');

Returns:

Promise<Episode[]>

Parameters:

NameTypeDescription
querystringThe query to search.
optionsSearchOptionsSome search options to make the search more efficient.