arya-ytpl v0.1.23

node-ytpl

Simple js only module to resolve YouTube playlist ids Doesn't need any login or GoogleAPI key

Usage

var ytpl = require('ytpl');

ytpl('UU_aEa8K-EOJ3D6gOs7HcyNg', function(err, playlist) {
  if(err) throw err;
  dosth(playlist);
});

API

ytpl(id, options, callback)

Attempts to resolve the given playlist id

• id
  • id of the yt-playlist
  • or playlist link
  • or user link (resolves uploaded playlist)
  • or channel link (resolves uploaded playlist)
• options
  • object with options
  • possible settings:
  • limitNumber -> limits the pulled items, defaults to 100, set to 0 or Infinity to get the whole playlist

• callback(err, result)

  • function
  • getting fired after the request is done
  • contains an error or a result

• returns a Promise when no callback is defined

• Example response

ytpl.validateURL(string)

Returns true if able to parse out a (formally) valid playlist ID.

ytpl.getPlaylistID(string, callback)

Returns a playlist ID from a YouTube URL. Can be called with the playlist ID directly, in which case it returns it. If callback isn't given, returns a promise.

Related / Works well with

• node-ytdl-core
• node-ytsr

Install

npm install --save ytpl

License

MIT