AlbumManager src/managers/Album.ts#L18
A manager to perform actions which belongs to the spotify album web api.
Properties:
clientMethods:
get getMultiple getTracks searchconstructor(client) src/managers/Album.ts#L18
No documentation found.
Name | Type | Description |
---|---|---|
client | Client | The spotify api client. |
.get(id, force) src/managers/Album.ts#L49
Get an album's information.
const album = await client.albums.get('id');
Returns:
Parameters:
Name | Type | Description |
---|---|---|
id | string | The spotify album id. |
force | boolean | When true, will directly fetch else will search for the cache first! |
.getMultiple(ids) src/managers/Album.ts#L61
Get the information of multiple albums in one fetch.
const albums = await client.albums.getMultiple(['id1', 'id2']);
Returns:
Parameters:
Name | Type | Description |
---|---|---|
ids | string[] | An array of spotify ids. |
.getTracks(id) src/managers/Album.ts#L72
Get the information about the album's tracks.
const tracks = await client.albums.getTracks('id');
Returns:
Parameters:
Name | Type | Description |
---|---|---|
id | string | The spotify album id. |
.search(query, options) src/managers/Album.ts#L27
Search for spotify albums with query.
const results = await client.albums.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. |