Yurba.js

Appearance

Yurba.js / @yurbajs/rest / MusebaseResource

Class: MusebaseResource ​

Playlists ​

addTrackToPlaylist() ​

addTrackToPlaylist(playlistId, trackId): Promise<BaseOkay>

Adds a track to playlist

Parameters ​

playlistId ​

number

Playlist identifier

trackId ​

number

Track identifier

Returns ​

Promise<BaseOkay>

BaseOkay Operation result

Since ​

1.0.0

Throws ​

If parameters are invalid

Example ​

javascript
await rest.musebase.addTrackToPlaylist(123, 456);

createPlaylist() ​

createPlaylist(name, release, description, cover): Promise<Playlist>

Creates a new playlist

Parameters ​

name ​

string

Playlist name

release ​

string

Release information

description ​

string

Playlist description

cover ​

number

Cover photo ID

Returns ​

Promise<Playlist>

Playlist Created playlist

Since ​

1.0.0

Throws ​

If playlist data is invalid

Example ​

javascript
const playlist = await rest.musebase.createPlaylist('My Playlist', '2024', 'Description', 123);

deletePlaylist() ​

deletePlaylist(playlistId): Promise<BaseOkay>

Deletes a playlist

Parameters ​

playlistId ​

number

Playlist identifier

Returns ​

Promise<BaseOkay>

DeletePlaylistResponse Delete response

Since ​

1.0.0

Throws ​

If playlist ID is invalid

Example ​

javascript
await rest.musebase.deletePlaylist(123);

getPlaylist() ​

getPlaylist(playlistId): Promise<Playlist>

Gets a playlist by identifier

Parameters ​

playlistId ​

number

Playlist identifier

Returns ​

Promise<Playlist>

Playlist object

Since ​

1.0.0

Throws ​

If playlist ID is invalid

Example ​

javascript
const playlist = await rest.musebase.getPlaylist(123);

getUserPlaylists() ​

getUserPlaylists(tag): Promise<Playlist[]>

Gets user playlists by tag

Parameters ​

tag ​

string

User tag

Returns ​

Promise<Playlist[]>

Array of Playlist objects

Since ​

1.0.0

Throws ​

If tag is invalid

Example ​

javascript
const playlists = await rest.musebase.getUserPlaylists('username');

removeTrackFromPlaylist() ​

removeTrackFromPlaylist(playlistId, trackId): Promise<Playlist>

Removes a track from playlist

Parameters ​

playlistId ​

number

Playlist identifier

trackId ​

number

Track identifier

Returns ​

Promise<Playlist>

DeleteTrackResponse Delete response

Since ​

1.0.0

Throws ​

If parameters are invalid

Example ​

javascript
await rest.musebase.removeTrackFromPlaylist(123, 456);

updatePlaylist() ​

updatePlaylist(playlistId, name, release, description, cover): Promise<BaseOkay>

Updates a playlist

Parameters ​

playlistId ​

number

Playlist identifier

name ​

string

Playlist name

release ​

string

Release information

description ​

string

Playlist description

cover ​

number

Cover photo ID

Returns ​

Promise<BaseOkay>

EditPlaylistResponse Update response

Since ​

1.0.0

Throws ​

If parameters are invalid

Example ​

javascript
await rest.musebase.updatePlaylist(123, 'Updated Name', '2024', 'New description', 456);

Tracks ​

find() ​

find(query, page?): Promise<Track[]>

Find tracks

Parameters ​

query ​

string

Song name or artist

page? ​

number

Page number (optional)

Returns ​

Promise<Track[]>

Track list

Since ​

1.0.0

Deprecated ​

Use rest.search.tracks() instead

Example ​

javascript
// Use rest.search.tracks() instead
const tracks = await rest.search.tracks('Bohemian Rhapsody');

getTrack() ​

getTrack(trackId): Promise<Track>

Gets a track by identifier

Parameters ​

trackId ​

number

Track identifier

Returns ​

Promise<Track>

Track object

Since ​

1.0.0

Throws ​

If track ID is invalid

Example ​

javascript
const track = await rest.musebase.getTrack(123);