Skip to content

Latest commit

 

History

History
1030 lines (867 loc) · 25.6 KB

DOCS.md

File metadata and controls

1030 lines (867 loc) · 25.6 KB

Classes

Deezer

API Instance

Functions

getChart() ⇒ promise
getChartTracks() ⇒ promise
getChartAlbums() ⇒ promise
getChartArtists() ⇒ promise
getChartPlaylists() ⇒ promise
getChartPodcasts() ⇒ promise
getComment(comment_id) ⇒ promise
getEditorials() ⇒ promise
getEpisode() ⇒ promise
getEpisodeBookmark() ⇒ promise
getGenres() ⇒ promise
getInfos() ⇒ promise
getOptions() ⇒ promise
search(type, query) ⇒ promise
getAlbum(album_id) ⇒ promise
getAlbumComments(album_id) ⇒ promise
getAlbumFans(album_id) ⇒ promise
getAlbumTracks(album_id) ⇒ promise
getPlaylist(playlist_id) ⇒ promise
getPlaylistComments(playlist_id) ⇒ promise
getPlaylistFans(playlist_id) ⇒ promise
getPlaylistTracks(playlist_id) ⇒ promise
getPodcast(podcast_id) ⇒ promise
getPodcastEpisodes(podcast_id) ⇒ promise
getRadios() ⇒ promise
getRadioGenres() ⇒ promise
getTopRadios() ⇒ promise
getRadioLists() ⇒ promise
getTrack(track_id) ⇒ promise
getArtist(artist_id) ⇒ promise
getArtistTopTracks(artist_id) ⇒ promise
getArtistAlbums(artist_id) ⇒ promise
getArtistComments(artist_id) ⇒ promise
getArtistFans(artist_id) ⇒ promise
getRelatedArtists(artist_id) ⇒ promise
getArtistRadio(artist_id) ⇒ promise
getArtistPlaylists(artist_id) ⇒ promise

Deezer

API Instance

Kind: global class

getChart() ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request
Example (Get chart)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.infos.getChart()
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getChartTracks() ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request
Example (Get chart tracks)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.infos.getChartTracks()
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getChartAlbums() ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request
Example (Get chart albums)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.infos.getChartAlbums()
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getChartArtists() ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request
Example (Get chart artists)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.infos.getChartArtists()
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getChartPlaylists() ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request
Example (Get chart playlists)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.infos.getChartPlaylists()
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getChartPodcasts() ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request
Example (Get chart podcasts)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.infos.getChartPodcasts()
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getComment(comment_id) ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request

Param Type Description
comment_id string ID of comment to get info

Example (Get comment info)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.infos.getComment("123123")
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getEditorials() ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request
Example (Get editorials)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.infos.getEditorials()
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getEpisode() ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request
Example (Get episode)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.infos.getEpisode()
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getEpisodeBookmark() ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request
Example (Get episode bookmark)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.infos.getEpisodeBookmark()
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getGenres() ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request
Example (Get genres)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.infos.getGenres()
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getInfos() ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request
Example (Get infos)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.infos.getInfos()
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getOptions() ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request
Example (Get options)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.infos.getOptions()
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

search(type, query) ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request

Param Type Description
type string Type of request allowed types (album, artist, history, playlist, podcast, radio, track, user), if null will search for all types
query string Your search

Example (Search things)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.infos.search("album", "Blurryface")
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

// Or try this

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.infos.search("Blurryface")
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getAlbum(album_id) ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request

Param Type Description
album_id string ID of album to get info

Example (Get information from an album)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.musics.getAlbum("1423549")
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getAlbumComments(album_id) ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request

Param Type Description
album_id string ID of album to get comments

Example (Get album comments)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.musics.getAlbumComments("1423549")
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getAlbumFans(album_id) ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request

Param Type Description
album_id string ID of album to get fans

Example (Get album fans)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.musics.getAlbumFans("1423549")
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getAlbumTracks(album_id) ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request

Param Type Description
album_id string ID of album to get tracks

Example (Get album tracks)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.musics.getAlbumTracks("1423549")
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getPlaylist(playlist_id) ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request

Param Type Description
playlist_id string ID of playlist to get info

Example (Get playlist)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.musics.getPlaylist("4721934964")
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getPlaylistComments(playlist_id) ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request

Param Type Description
playlist_id string ID of playlist to get comments

Example (Get playlist comments)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.musics.getPlaylistComments("4721934964")
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getPlaylistFans(playlist_id) ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request

Param Type Description
playlist_id string ID of playlist to get fans

Example (Get playlist fans)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.musics.getPlaylistFans("4721934964")
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getPlaylistTracks(playlist_id) ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request

Param Type Description
playlist_id string ID of playlist to get tracks

Example (Get playlist tracks)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.musics.getPlaylistTracks("4721934964")
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getPodcast(podcast_id) ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request

Param Type Description
podcast_id string ID of podcast to get info

Example (Get podcast)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.musics.getPodcast("4721934964")
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getPodcastEpisodes(podcast_id) ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request

Param Type Description
podcast_id string ID of podcast to get episodes

Example (Get podcast episodes)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.musics.getPodcastEpisodes("4721934964")
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getRadios() ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request
Example (Get radios)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.musics.getRadios()
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getRadioGenres() ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request
Example (Get radio genres)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.musics.getRadiosGenres()
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getTopRadios() ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request
Example (Get top radios)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.musics.getTopRadios()
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getRadioLists() ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request
Example (Get radio lists)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.musics.getRadiosLists()
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getTrack(track_id) ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request

Param Type Description
track_id string ID of track to get info

Example (Get track info)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.musics.getTrack("74606742")
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getArtist(artist_id) ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request

Param Type Description
artist_id string ID of artist to get info

Example (Get artist info)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.users.getArtist("1423549")
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getArtistTopTracks(artist_id) ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request

Param Type Description
artist_id string ID of artist to get top tracks

Example (Get artist top tracks)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.users.getArtistTopTracks("1423549")
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getArtistAlbums(artist_id) ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request

Param Type Description
artist_id string ID of artist to get albums

Example (Get artist albums)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.users.getArtistAlbums("1423549")
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getArtistComments(artist_id) ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request

Param Type Description
artist_id string ID of artist to get comments

Example (Get artist comments)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.users.getArtistComments("1423549")
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getArtistFans(artist_id) ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request

Param Type Description
artist_id string ID of artist to get fans

Example (Get artist fans)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.users.getArtistFans("1423549")
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getRelatedArtists(artist_id) ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request

Param Type Description
artist_id string ID of artist to get related artists

Example (Get related artists)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.users.getRelatedArtists("1423549")
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getArtistRadio(artist_id) ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request

Param Type Description
artist_id string ID of artist to get radio

Example (Get artist radio)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.users.getArtistRadio("1423549")
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();

getArtistPlaylists(artist_id) ⇒ promise

Kind: global function
Returns: promise - Returns a promise with the request

Param Type Description
artist_id string ID of artist to get playlists

Example (Get artist playlists)

var Deezer = require("deezer-web-api");

var DeezerClient = new Deezer();

async function example() {
   var res = await DeezerClient.users.getArtistPlaylists("1423549")
       .then((res) => {
           console.log(res);
       })
       .catch((err) => {
           console.log(err);
       });
}
example();