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