SpotifyApiSpotify LogoJS

ShowManager src/managers/Show.ts#L18

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


Properties:

client

Methods:

get getEpisodes getMultiple search

constructor(client) src/managers/Show.ts#L18

No documentation found.

NameTypeDescription
clientClientThe spotify api client.

.client

Type:

Client

No documentation found.

.get(id, market, force) src/managers/Show.ts#L50

Get an show's information.

const show = await client.shows.get('id');

Returns:

Promise<"null" | Show>

Parameters:

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

.getEpisodes(id, options) src/managers/Show.ts#L78

Get the information of the episodes of the show.

const episodes = await client.shows.getEpisodes('id');

Returns:

Promise<Episode[]>

Parameters:

NameTypeDescription
idstringThe spotify show id.
options{ limit?: number, market?: string, offset?: number, }The limit, offset, market query paramater options.

.getMultiple(ids, market) src/managers/Show.ts#L63

Get the information of multiple spotify shows in one fetch.

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

Returns:

Promise<Show[]>

Parameters:

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

.search(query, options) src/managers/Show.ts#L27

Search for spotify shows with query.

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

Returns:

Promise<Show[]>

Parameters:

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