ShowManager src/managers/Show.ts#L18
A manager to perform actions which belongs to the spotify show web api.
Properties:
clientMethods:
get getEpisodes getMultiple searchconstructor(client) src/managers/Show.ts#L18
No documentation found.
Name | Type | Description |
---|---|---|
client | Client | The spotify api client. |
.get(id, market, force) src/managers/Show.ts#L50
Get an show's information.
const show = await client.shows.get('id');
Returns:
Parameters:
Name | Type | Description |
---|---|---|
id | string | The spotify show id. |
market | string | Only shows that are available in that market will be returned. |
force | boolean | When 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:
Parameters:
Name | Type | Description |
---|---|---|
id | string | The 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:
Parameters:
Name | Type | Description |
---|---|---|
ids | string[] | An array of spotify ids. |
market | string | Only 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:
Parameters:
Name | Type | Description |
---|---|---|
query | string | The query to search. |
options | SearchOptions | Some search options to make the search more efficient. |