youtube.js
#
youtubeModule to handle communication with YouTube APIs
- youtube
- ~isVideoURL(URL) ⇒
boolean
- ~isPlaylistURL(URL) ⇒
boolean
- ~getPlaylistId(URL) ⇒
string
|null
- ~getPlaylistItems(playlistId) ⇒
Array
- ~searchByQuery(query) ⇒
Promise.<(string|null)>
- ~isVideoURL(URL) ⇒
boolean
#
youtube~isVideoURL(URL) ⇒ Kind: inner method of youtube
Returns: boolean
-
If the URL is a YouTube Video URL or not
Param | Type | Description |
---|---|---|
URL | string | The URL you want to test |
boolean
#
youtube~isPlaylistURL(URL) ⇒ Kind: inner method of youtube
Returns: boolean
-
If the URL is a YouTube Playlist URL or not
Param | Type | Description |
---|---|---|
URL | string | The URL you want to test |
string
| null
#
youtube~getPlaylistId(URL) ⇒ Kind: inner method of youtube
Returns: string
| null
-
The playlist id, if one could be found.
Param | Type | Description |
---|---|---|
URL | string | The URL you want get the playlist ID from |
Array
#
youtube~getPlaylistItems(playlistId) ⇒ Get playlist items
Kind: inner method of youtube
Returns: Array
-
Array of the playlist items
Param | Type | Description |
---|---|---|
playlistId | string | The ID of the YouTube playlist |
Promise.<(string|null)>
#
youtube~searchByQuery(query) ⇒ Searches for a track by the query provided
Kind: inner method of youtube
Returns: Promise.<(string|null)>
-
The found tracks YouTube URL, if any.
Param | Type | Description |
---|---|---|
query | string | The query you would like to search with |