diff --git a/gh-pages/.nojekyll b/docs/.nojekyll similarity index 100% rename from gh-pages/.nojekyll rename to docs/.nojekyll diff --git a/docs/Deezer/README.md b/docs/Deezer/README.md deleted file mode 100644 index 6f03caf..0000000 --- a/docs/Deezer/README.md +++ /dev/null @@ -1,181 +0,0 @@ -# Deezer - -## Main - -### deezer(url : `string`) - -_This returns data from a track | playlist | album url. Accepts share links as well, which it resolves first._ - -```js -let data = await deezer(url); //Gets the data - -console.log(data.type); // Console logs the type of data that you got. -``` - -## Validate - -### dz_validate(url : `string`) - -_This checks that given url is Deezer url or not._ - -**Returns :** `track` | `album` | `playlist` | `search` | `false` - -```js -let check = dz_validate(url) - -if(!check) // Invalid Deezer URL - -if(check === 'track') // Deezer Track URL - -if(check === "search") // Given term is a search query. Search it somewhere. -``` - -## Search - -### dz_search(query: `string`, options: `DeezerSearchOptions`) - -_Searches for tracks, playlists and albums._ - -**Returns :** `Deezer[]` an array of tracks, playlists or albums - -#### `DeezerSearchOptions` - -- **type?** `'track'` | `'playlist'` | `'album'` The type to search for. Defaults to `'track'`. -- **limit?** `number` The maximum number of results to return. Maximum `100`, defaults to `10`. -- **fuzzy?** `boolean` Whether the search should be fuzzy or only return exact matches. Defaults to `true`. - -```js -const results = await dz_search(query, { - limit: 1, - type: 'track', - fuzzy: false -}); // Returns an array with one track, using exact matching -``` - -### dz_advanced_track_search(options: `DeezerAdvancedSearchOptions`) - -_Searches Deezer for tracks using the specified metadata._ - -**Returns :** `DeezerTrack[]` an array of tracks - -#### `DeezerAdvancedSearchOptions` - -- **limit?** `number` The maximum number of results to return, maximum `100`, defaults to `10`. -- **artist?** `string` The name of the artist -- **album?** `string` The title of the album -- **title?** `string` The title of the track -- **label?** `string` The label that released the track -- **minDurationInSec?** `number` The minimum duration in seconds -- **maxDurationInSec?** `number` The maximum duration in seconds -- **minBpm?** `number` The minimum BPM -- **maxBpm?** `number` The minimum BPM - -```js -const results = await dz_advanced_track_search({ - limit: 1, - artist: 'Rick Astley', - title: 'Never Gonna Give You Up' -}); // Returns an array with one track -``` - -## Classes [ Returned by `deezer(url)` function ] - -### DeezerTrack - -_This is the class for a Deezer track._ - -##### type `property` - -_This will always return as "track" for this class._ - -##### partial `property` - -_Will return true for tracks in search results and false for tracks fetched directly or if the fetch function has been called. This being true means that the optional properties are undefined._ - -##### toJSON() `function` - -_Converts the object to JSON_ - -##### fetch() `function` - -_Fetches the missing data for a partial track._ - -```js -const track = await deezer(track_url); - -await track.fetch() // Fetches the missing data -``` - -### DeezerPlaylist - -_This is the class for a Deezer playlist._ - -##### fetch() `function` - -_This will fetch up to 1000 tracks in a playlist as well as the missing data for a partial playlist._ - -```js -let data = await deezer(playlist_url) - -await data.fetch() // Fetches tracks more than 100 tracks in playlist -``` - -##### tracksCount `property` - -_This will return the total number of tracks in a playlist._ - -```js -const data = await deezer(playlist_url) - -console.log(data.tracksCount) // Total number of tracks in the playlist. -``` - -##### type `property` - -_This will always return as "playlist" for this class._ - -##### partial `property` - -_Will return true for playlists in search results and false for playlists fetched directly or if the fetch function has been called. This being true means that the optional properties are undefined and `tracks` may be empty or partially filled._ - -##### tracks `property` - -_The array of tracks in this album, this is always empty (length of 0) for partial playlists._ - -```js -const data = await deezer(playlist_url); - -if (data.tracks.length !== data.tracksCount) { - await data.fetch(); -} - -console.log(data.tracks); // returns all tracks in the playlist -``` - -##### toJSON() `function` - -_Converts the object to JSON_ - -### DeezerAlbum - -_This is the class for a Deezer album._ - -##### type `property` - -_This will always return as "track" for this class._ - -##### tracks `property` - -_The array of tracks in this album, this is always empty (length of 0) for partial albums._ - -##### partial `property` - -_Will return true for albums in search results and false for albums fetched directly or if the fetch function has been called. This being true means that the optional properties are undefined._ - -##### toJSON() `function` - -_Converts the object to JSON_ - -##### fetch() `function` - -_Fetches the missing data for a partial album._ diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 8de1c7f..0000000 --- a/docs/README.md +++ /dev/null @@ -1,190 +0,0 @@ -# Play-dl commands - -For source specific commands :- - -- [YouTube](https://github.com/play-dl/play-dl/tree/main/docs/YouTube#youtube) -- [Spotify](https://github.com/play-dl/play-dl/tree/main/docs/Spotify#spotify) -- [SoundCloud](https://github.com/play-dl/play-dl/tree/main/docs/SoundCloud) - -### Validate - -#### validate(url : `string`) - -_This checks all type of urls that are supported by play-dl._ - -**Returns :** `so_playlist` | `so_track` | `sp_track` | `sp_album` | `sp_playlist` | `dz_track` | `dz_playlist` | `dz_album` | `yt_video` | `yt_playlist` | `search` | `false` - -`so` = **SoundCloud** - -`sp` = **Spotify** - -`yt` = **YouTube** - -`dz` = **Deezer** - -```js -let check = await validate(url) - -if(!check) // Invalid URL - -if(check === 'yt_video') // YouTube Video - -if(check === 'sp_track') // Spotify Track - -if(check === 'so_track') // SoundCloud Track - -if(check === 'dz_track') // Deezer Track - -if(check === "search") // Given term is not a url. Search this term somewhere. -``` - -### authorization() - -_This creates basic spotify / soundcloud / youtube data to be stored locally._ - -```js -authorization() //After then you will be asked about type of data you want to create and then follow the steps properly. -``` - -### setToken(options : `TokenOptions`) - -_This sets token without using file._ - -```js -setToken({ - spotify : { - client_id : "ID", - client_secret : "Secret", - refresh_token : "Token", - market : "Country Code" - } -}) // Setting Spotify Token [ To get refresh_token, just run through authorization, and set file save to No ] - -setToken({ - soundcloud : { - client_id : "ID" - } -}) // Setting SoundCloud Token - -setToken({ - youtube : { - cookie : "Cookies" - } -}) // Warning : Using setToken for youtube cookies will only update cookies present in memory only. -``` - -### Search - -#### SearchOptions : - -- limit : `number` :- Sets total amount of results you want. -- source : { - - youtube: `video` | `playlist` | `channel` ; - - spotify: `album` | `playlist` | `track` ; - - soundcloud: `tracks` | `playlists` | `albums` ; - - deezer: `track` | `playlist` | `album` ; - - } - -#### search(query : `string`, options? : [`SearchOptions`](https://github.com/play-dl/play-dl/tree/main/docs#searchoptions-)) - -_This is basic to search with any source._ - -**NOTE :-** If options.source is not specified, then it will default to youtube video search. - -```js -let data = await search('Rick Roll', { limit : 1 }) // Searches for youtube video - -let data = await search('Rick Roll', { limit : 1, source : { youtube : "video" } }) // Searches for youtube video - -let data = await search('Rick Roll', { limit: 1, source : { spotify : "track" } }) // Searches for spotify track. - -let data = await search('Rick Roll', { limit: 1, source : { soundcloud : "tracks" } }) // Searches for soundcloud track. - -let data = await search('Rick Roll', { limit: 1, source : { deezer : "track" } }) // Searches for a Deezer track. -``` - -### Stream - -**Attaching events to player is important for stream to work.** - -#### attachListeners(player : `AudioPlayer`, resource : `YouTubeStream | SoundCloudStream`) - -_This is used for attaching pause and playing events to audioPlayer._ - -```js -let resource = await stream("url") - -let player = createAudioPlayer() - -attachListeners(player, resource) -``` - -#### StreamOptions : - -- quality : `number` :- Sets quality of stream [ 0 = Lowest, 1 = Medium ]. Leave this empty to get highest audio quality. -- proxy : `Proxy` :- Optional parameter to add support of proxies. As of now, HTTPS proxies are only supported. So make sure to get HTTPS proxies only. - -#### stream(url : `string`, options? : [`StreamOptions`](https://github.com/play-dl/play-dl/tree/main/docs#streamoptions-)) - -_This is basic to create a stream from a youtube or soundcloud url._ - -```js -let source = await stream("url") // This will create a stream Class. Highest Quality - -let source = await stream("url", { quality : 0 }) // Lowest quality - -let source = await stream("url", { quality : 1 }) // Next to Lowest quality. - -let source = await stream(url, { proxy : ['url'] }) // Accepts a url which has port in it. - -let source = await stream(url. {proxy : [{ - host : "IP or hostname", - port : 8080 - }] -}) // Or add a json containing hostname and port. - -let resource = createAudioResource(source.stream, { - inputType : source.type - }) // This creates resource for playing -``` - -#### stream_from_info(info : `infoData`, options? : [`StreamOptions`](https://github.com/play-dl/play-dl/tree/main/docs#streamoptions-)) - -_This is basic to create a stream from a info [ from [video_info](https://github.com/play-dl/play-dl#video_infourl--string) function or [soundcloud](https://github.com/play-dl/play-dl/tree/main/docs/SoundCloud#soundcloudurl--string) function [**Only SoundCloudTrack class is allowed**] ]._ - -**Note :** Here, cookies are required only for retrying purposes. - -```js -let source = await stream_from_info(info) // This will create a stream Class from video_info or SoundCoudTrack Class. Highest Quality - -let source = await stream_from_info(info, { quality : 0 }) // Lowest quality - -let source = await stream_from_info(info, { quality : 1 }) // Next to Lowest quality. - -let source = await stream_from_info(info, { proxy : ['url'] }) // Accepts a url which has port in it. - -let source = await stream_from_info(info, {proxy : [{ - host : "IP or hostname", - port : 8080 - }] -}) // Or add a json containing hostname and port. - -let resource = createAudioResource(source.stream, { - inputType : source.type - }) // This creates resource for playing -``` - -#### cookieHeaders(headersCookie : `string[]`) - -_This is function to update youtube cookies when using external https module._ - -```js -const res = ... // You need to get response. - -play.cookieHeaders(res.headers['set-cookie']) // Updates YouTube Cookies if cookies exists. -``` \ No newline at end of file diff --git a/docs/SoundCloud/README.md b/docs/SoundCloud/README.md deleted file mode 100644 index 61522ec..0000000 --- a/docs/SoundCloud/README.md +++ /dev/null @@ -1,115 +0,0 @@ -# SoundCloud - -## Main - -### soundcloud(url : `string`) - -_This returns data from a track | playlist url._ - -```js -let data = await soundcloud(url) //Gets the data - -console.log(data.type) // Console logs the type of data that you got. -``` - -### getFreeClientID() - -_This returns free client ID._ - -```js -const client_id = await getFreeClientID() - -setToken({ - soundcloud : { - client_id : client_id - } -}) // This will set client ID for use in play-dl. -``` - -## Validate - -### so_validate(url : `string`) - -_This checks that given url is soundcloud url or not._ - -**Returns :** `track` | `playlist` | `search` | `false` - -```js -let check = await so_validate(url) - -if(!check) // Invalid SoundCloud URL - -if(check === 'track') // SoundCloud Track URL - -if(check === "search") // Given term is not a SoundCloud URL. Search this somewhere. -``` - -## Classes [ Returned by `soundcloud(url)` function ] - -### SoundCloudTrack - -_This is class for a soundcloud track._ - -##### type `property` - -_This will always return as "track" for this class._ - -##### toJSON() `function` - -_converts class into a json format_ - -### SoundCloudPlaylist - -_This is a soundcloud playlist class._ - -##### fetch() `function` - -_This will fetch tracks in a playlist._ - -```js -let data = await soundcloud(playlist_url) - -await data.fetch() // Fetches all unfetched tracks in playlist -``` - -##### tracksCount `property` - -_This will give no. of tracks in a playlist._ - -```js -let data = await soundcloud(playlist_url) - -console.log(data.tracksCount) // Returns total tracks count in a playlist -``` - -#### tracks `property` - -_This will give all tracks fetched as array._ - -```js -let data = await soundcloud(playlist_url) - -console.log(data.tracks) // Tracks Array - -data.tracks.forEach((track) => { - queue.push(track) // This will push every track in playlist to your queue -}) -``` - -#### total_tracks `property` - -_This give total videos that have been fetched so far._ - -```js -let data = await soundcloud(playlist_url) - -console.log(data.total_tracks) // This will tell no. of videos that have been fetched so far. -``` - -##### type `property` - -_This will always return as "playlist" for this class._ - -##### toJSON() `function` - -_converts class into a json format_ diff --git a/docs/Spotify/README.md b/docs/Spotify/README.md deleted file mode 100644 index 47c353d..0000000 --- a/docs/Spotify/README.md +++ /dev/null @@ -1,204 +0,0 @@ -# Spotify - -## Main - -### spotify(url : `string`) - -_This returns data from a track | playlist | album url._ - -```js -let data = await spotify(url) //Gets the data - -console.log(data.type) // Console logs the type of data that you got. -``` - - -## Validate - -### sp_validate(url : `string`) - -_This checks that given url is spotify url or not._ - -**Returns :** `track` | `album` | `playlist` | `search` | `false` - -```js -let check = sp_validate(url) - -if(!check) // Invalid Spotify URL - -if(check === 'track') // Spotify Track URL - -if(check === "search") // Given term is a spotify url. Search it somewhere. -``` - -### is_expired() - -_This tells that whether the access token is expired or not_ - -**Returns :** `boolean` - -```js -if(is_expired()){ - await refreshToken() -} -``` - -### refreshToken() - -_This refreshes the access token._ - -**Returns :** `boolean` for telling whether access token is refreshed or not - -```js -await refreshToken() -``` - -## Classes [ Returned by `spotify(url)` function ] - -### SpotifyVideo - -_Don't go by the name. This is class for a spotify track._ - -##### type `property` - -_This will always return as "track" for this class._ - -##### toJSON() `function` - -_converts class into a json format_ - -### SpotifyPlaylist - -_This is a spotify playlist class._ - -##### fetch() `function` - -_This will fetch tracks in a playlist upto 1000 tracks only._ - -```js -let data = await spotify(playlist_url) - -await data.fetch() // Fetches tracks more than 100 tracks in playlist -``` - -##### tracksCount `property` - -_This will give no. of tracks in a playlist._ - -```js -let data = await spotify(playlist_url) - -console.log(data.tracksCount) // Returns total tracks count in a playlist -``` - -##### page(page_number : `number`) - -_This will return array of tracks in that page._ - -> Same as youtube playlist pages - -```js -let data = await spotify(playlist_url) - -console.log(data.page(1)) //This will give first 100 tracks in playlist. -``` - -- total_pages `property` - - _This give total pages that have been fetched so far._ - - ```js - let data = await spotify(playlist_url) - - console.log(data.total_pages) // This will tell no. of pages that have been fetched so far. - - for(let i = 1; i <= data.total_pages; i++){ - queue.push(data.page(i)) //This will push all tracks to your queue system - } - ``` - -- total_tracks `property` - - _This give total videos that have been fetched so far._ - - ```js - let data = await spotify(playlist_url) - - console.log(data.total_tracks) // This will tell no. of videos that have been fetched so far. - ``` - -##### type `property` - -_This will always return as "playlist" for this class._ - -##### toJSON() `function` - -_converts class into a json format_ - -### SpotifyAlbum - -_This is a spotify albun class._ - -##### fetch() `function` - -_This will fetch tracks in a album upto 500 tracks only._ - -```js -let data = await spotify(playlist_url) - -await data.fetch() // Fetches tracks more than 50 tracks in album -``` - -##### tracksCount `property` - -_This will give no. of tracks in a playlist._ - -```js -let data = await spotify(playlist_url) - -console.log(data.tracksCount) // Returns total tracks count in a album -``` - -##### page(page_number : `number`) - -_This will return array of tracks in that page._ - -> Same as youtube playlist pages - -```js -let data = await spotify(playlist_url) - -console.log(data.page(1)) //This will give first 50 tracks in album. -``` - -- total_pages `property` - - _This give total pages that have been fetched so far._ - - ```js - let data = await spotify(playlist_url) - - console.log(data.total_pages) // This will tell no. of pages that have been fetched so far. - - for(let i = 1; i <= data.total_pages; i++){ - queue.push(data.page(i)) //This will push all tracks to your queue system - } - ``` - -- total_tracks `property` - - _This give total videos that have been fetched so far._ - - ```js - let data = await spotify(playlist_url) - - console.log(data.total_tracks) // This will tell no. of videos that have been fetched so far. - ``` - -##### type `property` - -_This will always return as "album" for this class._ - -##### toJSON() `function` - -_converts class into a json format_ diff --git a/docs/YouTube/README.md b/docs/YouTube/README.md deleted file mode 100644 index ebe110e..0000000 --- a/docs/YouTube/README.md +++ /dev/null @@ -1,198 +0,0 @@ -# YouTube - -## Basic Usage - -```js -const youtube = require('play-dl'); -// ES6: import youtube from 'play-dl'; -const options = { - limit : 1 -} -const results = await youtube.search('post malone sunflower', options); -``` - -## Validate - -### yt_validate(url : `string`) - -_This will validate url and return type or boolean_ - -**Returns :** `video` | `playlist` | `search` | `false` - -```js -let check = yt_validate(url) - -if(!check) // Invalid URL - -if(check === "video") //URL is video url - -if(check === "playlist") //URL is a playlist url - -if(check === "search") // Given term is not a video ID and PlayList ID. -``` - -## Extract ID - -### extractID(url : `string`) - -_This will return videoID or playlistID from a url_ - -**Note :** URL like [this](https://www.youtube.com/watch?v=E2gHczUOCGI&list=PLUt3leKZfbZqLzLwcQMYPBdbe7i7KRCOP&index=2) will return a playlist ID only. - -```js -let id = extractID(url) -``` - -## Video - -### InfoOptions - -_This are the info options that can be passed as a parameter in `video_info` and `video_basic_info`_ - -- proxy : Optional parameter to add support of proxies. As of now, HTTPS proxies are only supported. So make sure to get HTTPS proxies only. -- htmldata : `boolean` Set this to true if you are passing a html body as first parameter. - -```js -const video = await video_basic_info(url, { proxy : ['url'] }) // Accepts a url which has port in it. - -const video = await video_basic_info(url, {proxy : [{ - host : "IP or hostname", - port : 8080 - }] -}) // Or add a json containing hostname and port. - -// Use any https package to use proxy and then do this - -const video = await video_basic_info(body, { htmldata : true }) // You can use video_info function also. -``` - -### video_basic_info(url : `string`, options? : [`InfoOptions`](https://github.com/play-dl/play-dl/tree/main/docs/YouTube#infooptions)) - -_The basic video details `play-dl` fetches at first from url or videoID._ - -```js -const video = await video_basic_info(url) -``` - -### video_info(url : `string`, , options? : [`InfoOptions`](https://github.com/play-dl/play-dl/tree/main/docs/YouTube#infooptions)) - -_This contains everything with deciphered formats along with `video_details`. It can fetech data from url or videoID._ - -```js -const video = await video_info(url) -``` - -- #### format `property` - - _This returns all the formats available for a video._ - - ```js - const video = await video_info(url) - console.log(video.format) - ``` - -### decipher_info(data : `InfoData`) - -_This contains everything with deciphered formats along with `video_details`. It uses data returned by [`video_basic_info`](https://github.com/play-dl/play-dl/tree/main/docs/YouTube#video_basic_infourl--string-options--infooptions). This function is useful if you use [`video_basic_info`](https://github.com/play-dl/play-dl/tree/main/docs/YouTube#video_basic_infourl--string-options--infooptions) earlier in your code and want to convert the output for use with [`stream_from_info`](https://github.com/play-dl/play-dl/tree/main/docs#stream_from_infoinfo--infodata-options--streamoptions)_ - -```js -const basic_video = await video_basic_info(url); - -const video = await decipher_info(basic_video); -``` - -## Playlist - -### playlist_info(url : `string`, options : `PlaylistOptions`) - -_This fetches all details about a playlist from a url or playlistID._ - -```js -const playlist = await playlist_info(url) -//This only fetches first 100 videos from a playlist - -const playlist = await playlist_info(url, { incomplete : true }) -//This only fetches first 100 videos from a playlist and also parses playlist with hidden videos - -const playlist = await playlist_info(url, { proxy : [''] }) // Same 2 options as mentioned in InfoOptions -``` - -- #### fetch() `method` - - _This fetches and returns all videos from the whole provided playlist ._ - - ```js - const playlist = await playlist_info(url) - //This only fetches first 100 videos from a playlist - - await playlist.fetch() - // This one fetches all videos from a playlist. - ``` - -- #### page(page_number : `number`) - - _This returns no. of videos from a page._ - - > Every 100 videos have been divided into pages. - > Example: There are 782 videos in a playlist, so there will be 8 pages. - - ```js - const playlist = await playlist_info(url); - // This only fetches first 100 videos from a playlist. - - await playlist.fetch(); - // This one fetches all videos from a playlist. - - console.log(playlist.page(1)); - // This displays first 100 videos of a playlist - - ``` - -- #### total_pages `property` - - _This returns total no. of pages that have been fetched so far._ - - ```js - const playlist = await playlist_info(url) - //This only fetches first 100 videos from a playlist. - - await playlist.fetch() - // This one fetches all videos from a playlist. - - console.log(playlist.total_pages) - // This displays total no. of pages fetched so far. - - for(let i = 1; i <= playlist.total_pages; i++){ - queue.push(...playlist.page(i)) - } // This will push every video in that playlist to your queue - ``` - -- #### total_videos `property` - - _This returns total no. of videos that have been fetched so far._ - - ```js - const playlist = await playlist_info(url) - //This only fetches first 100 videos from a playlist. - - await playlist.fetch() - // This one fetches all videos from a playlist. - - console.log(playlist.total_videos) - // This displays total no. of videos fetched so far. - ``` - -- #### videoCount `property` - - _This returns total no. of videos in the provided playlist._ - - ```js - const playlist = await playlist_info(url) - //This only fetches first 100 videos from a playlist. - - await playlist.fetch() - // This one fetches all videos from a playlist. - - console.log(playlist.videoCount) - // This displays total no. of videos in a playlist. - ``` diff --git a/gh-pages/assets/highlight.css b/docs/assets/highlight.css similarity index 100% rename from gh-pages/assets/highlight.css rename to docs/assets/highlight.css diff --git a/gh-pages/assets/icons.css b/docs/assets/icons.css similarity index 100% rename from gh-pages/assets/icons.css rename to docs/assets/icons.css diff --git a/gh-pages/assets/icons.png b/docs/assets/icons.png similarity index 100% rename from gh-pages/assets/icons.png rename to docs/assets/icons.png diff --git a/gh-pages/assets/icons@2x.png b/docs/assets/icons@2x.png similarity index 100% rename from gh-pages/assets/icons@2x.png rename to docs/assets/icons@2x.png diff --git a/gh-pages/assets/main.js b/docs/assets/main.js similarity index 100% rename from gh-pages/assets/main.js rename to docs/assets/main.js diff --git a/gh-pages/assets/search.js b/docs/assets/search.js similarity index 100% rename from gh-pages/assets/search.js rename to docs/assets/search.js diff --git a/gh-pages/assets/style.css b/docs/assets/style.css similarity index 100% rename from gh-pages/assets/style.css rename to docs/assets/style.css diff --git a/gh-pages/assets/widgets.png b/docs/assets/widgets.png similarity index 100% rename from gh-pages/assets/widgets.png rename to docs/assets/widgets.png diff --git a/gh-pages/assets/widgets@2x.png b/docs/assets/widgets@2x.png similarity index 100% rename from gh-pages/assets/widgets@2x.png rename to docs/assets/widgets@2x.png diff --git a/gh-pages/classes/_internal_.DeezerAlbum.html b/docs/classes/_internal_.DeezerAlbum.html similarity index 97% rename from gh-pages/classes/_internal_.DeezerAlbum.html rename to docs/classes/_internal_.DeezerAlbum.html index 3d95a94..0e61e0e 100644 --- a/gh-pages/classes/_internal_.DeezerAlbum.html +++ b/docs/classes/_internal_.DeezerAlbum.html @@ -1,7 +1,7 @@ DeezerAlbum | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class for Deezer Albums

-

Hierarchy

  • DeezerAlbum

Index

Constructors

constructor

  • new DeezerAlbum(data: any, partial: boolean): DeezerAlbum

Properties

artist

artist: DeezerArtist

Optional available

available?: boolean

Optional contributors

contributors?: DeezerArtist[]

cover

Optional durationInSec

durationInSec?: number

explicit

explicit: boolean

Optional genres

genres?: DeezerGenre[]

id

id: number

Optional numberOfFans

numberOfFans?: number

partial

partial: boolean
+

Hierarchy

  • DeezerAlbum

Index

Constructors

constructor

  • new DeezerAlbum(data: any, partial: boolean): DeezerAlbum

Properties

artist

artist: DeezerArtist

Optional available

available?: boolean

Optional contributors

contributors?: DeezerArtist[]

cover

Optional durationInSec

durationInSec?: number

explicit

explicit: boolean

Optional genres

genres?: DeezerGenre[]

id

id: number

Optional numberOfFans

numberOfFans?: number

partial

partial: boolean

true for albums in search results and false if the album was fetched directly.

-

recordType

recordType: string

Optional releaseDate

releaseDate?: <internal>.Date

title

title: string

tracks

tracks: DeezerTrack[]

tracksCount

tracksCount: number

type

type: "playlist" | "track" | "album"

Optional upc

upc?: string

url

url: string

Methods

fetch

recordType

recordType: string

Optional releaseDate

releaseDate?: <internal>.Date

title

title: string

tracks

tracks: DeezerTrack[]

tracksCount

tracksCount: number

type

type: "playlist" | "track" | "album"

Optional upc

upc?: string

url

url: string

Methods

fetch

toJSON

  • toJSON(): { artist: DeezerArtist; available: undefined | boolean; contributors: undefined | DeezerArtist[]; cover: DeezerImage; durationInSec: undefined | number; explicit: boolean; genres: undefined | DeezerGenre[]; id: number; numberOfFans: undefined | number; recordType: string; releaseDate: undefined | <internal>.Date; title: string; tracks: { album: DeezerTrackAlbum; artist: DeezerArtist; bpm: undefined | number; contributors: undefined | DeezerArtist[]; diskNumber: undefined | number; durationInSec: number; explicit: boolean; gain: undefined | number; id: number; previewURL: string; rank: number; releaseDate: undefined | <internal>.Date; shortTitle: string; title: string; trackPosition: undefined | number; type: "playlist" | "track" | "album"; url: string }[]; tracksCount: number; type: "playlist" | "track" | "album"; upc: undefined | string; url: string }
  • Returns { artist: DeezerArtist; available: undefined | boolean; contributors: undefined | DeezerArtist[]; cover: DeezerImage; durationInSec: undefined | number; explicit: boolean; genres: undefined | DeezerGenre[]; id: number; numberOfFans: undefined | number; recordType: string; releaseDate: undefined | <internal>.Date; title: string; tracks: { album: DeezerTrackAlbum; artist: DeezerArtist; bpm: undefined | number; contributors: undefined | DeezerArtist[]; diskNumber: undefined | number; durationInSec: number; explicit: boolean; gain: undefined | number; id: number; previewURL: string; rank: number; releaseDate: undefined | <internal>.Date; shortTitle: string; title: string; trackPosition: undefined | number; type: "playlist" | "track" | "album"; url: string }[]; tracksCount: number; type: "playlist" | "track" | "album"; upc: undefined | string; url: string }

    • artist: DeezerArtist
    • available: undefined | boolean
    • contributors: undefined | DeezerArtist[]
    • cover: DeezerImage
    • durationInSec: undefined | number
    • explicit: boolean
    • genres: undefined | DeezerGenre[]
    • id: number
    • numberOfFans: undefined | number
    • recordType: string
    • releaseDate: undefined | <internal>.Date
    • title: string
    • tracks: { album: DeezerTrackAlbum; artist: DeezerArtist; bpm: undefined | number; contributors: undefined | DeezerArtist[]; diskNumber: undefined | number; durationInSec: number; explicit: boolean; gain: undefined | number; id: number; previewURL: string; rank: number; releaseDate: undefined | <internal>.Date; shortTitle: string; title: string; trackPosition: undefined | number; type: "playlist" | "track" | "album"; url: string }[]
    • tracksCount: number
    • type: "playlist" | "track" | "album"
    • upc: undefined | string
    • url: string

Generated using TypeDoc

\ No newline at end of file +

Returns <internal>.Promise<DeezerAlbum>

toJSON

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/classes/_internal_.DeezerArtist.html b/docs/classes/_internal_.DeezerArtist.html similarity index 94% rename from gh-pages/classes/_internal_.DeezerArtist.html rename to docs/classes/_internal_.DeezerArtist.html index 9eb6f66..88484ec 100644 --- a/gh-pages/classes/_internal_.DeezerArtist.html +++ b/docs/classes/_internal_.DeezerArtist.html @@ -1 +1 @@ -DeezerArtist | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • DeezerArtist

Index

Constructors

Properties

Constructors

constructor

Properties

id

id: number

name

name: string

Optional picture

picture?: DeezerImage

Optional role

role?: string

url

url: string

Generated using TypeDoc

\ No newline at end of file +DeezerArtist | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • DeezerArtist

Index

Constructors

Properties

Constructors

constructor

Properties

id

id: number

name

name: string

Optional picture

picture?: DeezerImage

Optional role

role?: string

url

url: string

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/classes/_internal_.DeezerPlaylist.html b/docs/classes/_internal_.DeezerPlaylist.html similarity index 96% rename from gh-pages/classes/_internal_.DeezerPlaylist.html rename to docs/classes/_internal_.DeezerPlaylist.html index f077e5b..54947e9 100644 --- a/gh-pages/classes/_internal_.DeezerPlaylist.html +++ b/docs/classes/_internal_.DeezerPlaylist.html @@ -1,6 +1,6 @@ DeezerPlaylist | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class for Deezer Albums

-

Hierarchy

  • DeezerPlaylist

Index

Constructors

constructor

Properties

Optional collaborative

collaborative?: boolean

creationDate

creationDate: <internal>.Date

creator

creator: DeezerUser

Optional description

description?: string

Optional durationInSec

durationInSec?: number

Optional fans

fans?: number

id

id: number

Optional isLoved

isLoved?: boolean

partial

partial: boolean

picture

picture: DeezerImage

public

public: boolean

title

title: string

tracks

tracks: DeezerTrack[]

tracksCount

tracksCount: number

type

type: "playlist" | "track" | "album"

url

url: string

Methods

fetch

Hierarchy

  • DeezerPlaylist

Index

Constructors

constructor

Properties

Optional collaborative

collaborative?: boolean

creationDate

creationDate: <internal>.Date

creator

creator: DeezerUser

Optional description

description?: string

Optional durationInSec

durationInSec?: number

Optional fans

fans?: number

id

id: number

Optional isLoved

isLoved?: boolean

partial

partial: boolean

picture

picture: DeezerImage

public

public: boolean

title

title: string

tracks

tracks: DeezerTrack[]

tracksCount

tracksCount: number

type

type: "playlist" | "track" | "album"

url

url: string

Methods

fetch

toJSON

  • toJSON(): { collaborative: undefined | boolean; creationDate: <internal>.Date; creator: DeezerUser; description: undefined | string; durationInSec: undefined | number; fans: undefined | number; id: number; isLoved: undefined | boolean; picture: DeezerImage; public: boolean; title: string; tracks: { album: DeezerTrackAlbum; artist: DeezerArtist; bpm: undefined | number; contributors: undefined | DeezerArtist[]; diskNumber: undefined | number; durationInSec: number; explicit: boolean; gain: undefined | number; id: number; previewURL: string; rank: number; releaseDate: undefined | <internal>.Date; shortTitle: string; title: string; trackPosition: undefined | number; type: "playlist" | "track" | "album"; url: string }[]; tracksCount: number; type: "playlist" | "track" | "album"; url: string }
  • Returns { collaborative: undefined | boolean; creationDate: <internal>.Date; creator: DeezerUser; description: undefined | string; durationInSec: undefined | number; fans: undefined | number; id: number; isLoved: undefined | boolean; picture: DeezerImage; public: boolean; title: string; tracks: { album: DeezerTrackAlbum; artist: DeezerArtist; bpm: undefined | number; contributors: undefined | DeezerArtist[]; diskNumber: undefined | number; durationInSec: number; explicit: boolean; gain: undefined | number; id: number; previewURL: string; rank: number; releaseDate: undefined | <internal>.Date; shortTitle: string; title: string; trackPosition: undefined | number; type: "playlist" | "track" | "album"; url: string }[]; tracksCount: number; type: "playlist" | "track" | "album"; url: string }

    • collaborative: undefined | boolean
    • creationDate: <internal>.Date
    • creator: DeezerUser
    • description: undefined | string
    • durationInSec: undefined | number
    • fans: undefined | number
    • id: number
    • isLoved: undefined | boolean
    • picture: DeezerImage
    • public: boolean
    • title: string
    • tracks: { album: DeezerTrackAlbum; artist: DeezerArtist; bpm: undefined | number; contributors: undefined | DeezerArtist[]; diskNumber: undefined | number; durationInSec: number; explicit: boolean; gain: undefined | number; id: number; previewURL: string; rank: number; releaseDate: undefined | <internal>.Date; shortTitle: string; title: string; trackPosition: undefined | number; type: "playlist" | "track" | "album"; url: string }[]
    • tracksCount: number
    • type: "playlist" | "track" | "album"
    • url: string

Generated using TypeDoc

\ No newline at end of file +

toJSON

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/classes/_internal_.DeezerTrack.html b/docs/classes/_internal_.DeezerTrack.html similarity index 96% rename from gh-pages/classes/_internal_.DeezerTrack.html rename to docs/classes/_internal_.DeezerTrack.html index 0bde087..d971665 100644 --- a/gh-pages/classes/_internal_.DeezerTrack.html +++ b/docs/classes/_internal_.DeezerTrack.html @@ -1,7 +1,7 @@ DeezerTrack | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class for Deezer Tracks

-

Hierarchy

  • DeezerTrack

Index

Constructors

constructor

  • new DeezerTrack(data: any, partial: boolean): DeezerTrack

Properties

album

artist

artist: DeezerArtist

Optional bpm

bpm?: number

Optional contributors

contributors?: DeezerArtist[]

Optional diskNumber

diskNumber?: number

durationInSec

durationInSec: number

explicit

explicit: boolean

Optional gain

gain?: number

id

id: number

partial

partial: boolean
+

Hierarchy

  • DeezerTrack

Index

Constructors

constructor

  • new DeezerTrack(data: any, partial: boolean): DeezerTrack

Properties

album

artist

artist: DeezerArtist

Optional bpm

bpm?: number

Optional contributors

contributors?: DeezerArtist[]

Optional diskNumber

diskNumber?: number

durationInSec

durationInSec: number

explicit

explicit: boolean

Optional gain

gain?: number

id

id: number

partial

partial: boolean

true for tracks in search results and false if the track was fetched directly.

-

previewURL

previewURL: string

rank

rank: number

Optional releaseDate

releaseDate?: <internal>.Date

shortTitle

shortTitle: string

title

title: string

Optional trackPosition

trackPosition?: number

type

type: "playlist" | "track" | "album"

url

url: string

Methods

fetch

previewURL

previewURL: string

rank

rank: number

Optional releaseDate

releaseDate?: <internal>.Date

shortTitle

shortTitle: string

title

title: string

Optional trackPosition

trackPosition?: number

type

type: "playlist" | "track" | "album"

url

url: string

Methods

fetch

toJSON

  • toJSON(): { album: DeezerTrackAlbum; artist: DeezerArtist; bpm: undefined | number; contributors: undefined | DeezerArtist[]; diskNumber: undefined | number; durationInSec: number; explicit: boolean; gain: undefined | number; id: number; previewURL: string; rank: number; releaseDate: undefined | <internal>.Date; shortTitle: string; title: string; trackPosition: undefined | number; type: "playlist" | "track" | "album"; url: string }
  • Returns { album: DeezerTrackAlbum; artist: DeezerArtist; bpm: undefined | number; contributors: undefined | DeezerArtist[]; diskNumber: undefined | number; durationInSec: number; explicit: boolean; gain: undefined | number; id: number; previewURL: string; rank: number; releaseDate: undefined | <internal>.Date; shortTitle: string; title: string; trackPosition: undefined | number; type: "playlist" | "track" | "album"; url: string }

    • album: DeezerTrackAlbum
    • artist: DeezerArtist
    • bpm: undefined | number
    • contributors: undefined | DeezerArtist[]
    • diskNumber: undefined | number
    • durationInSec: number
    • explicit: boolean
    • gain: undefined | number
    • id: number
    • previewURL: string
    • rank: number
    • releaseDate: undefined | <internal>.Date
    • shortTitle: string
    • title: string
    • trackPosition: undefined | number
    • type: "playlist" | "track" | "album"
    • url: string

Generated using TypeDoc

\ No newline at end of file +

Returns <internal>.Promise<DeezerTrack>

toJSON

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/classes/_internal_.DeezerTrackAlbum.html b/docs/classes/_internal_.DeezerTrackAlbum.html similarity index 95% rename from gh-pages/classes/_internal_.DeezerTrackAlbum.html rename to docs/classes/_internal_.DeezerTrackAlbum.html index 4984db0..89fa56c 100644 --- a/gh-pages/classes/_internal_.DeezerTrackAlbum.html +++ b/docs/classes/_internal_.DeezerTrackAlbum.html @@ -1 +1 @@ -DeezerTrackAlbum | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DeezerTrackAlbum

Hierarchy

  • DeezerTrackAlbum

Index

Constructors

constructor

Properties

cover

id

id: number

Optional releaseDate

releaseDate?: <internal>.Date

title

title: string

url

url: string

Generated using TypeDoc

\ No newline at end of file +DeezerTrackAlbum | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DeezerTrackAlbum

Hierarchy

  • DeezerTrackAlbum

Index

Constructors

constructor

Properties

cover

id

id: number

Optional releaseDate

releaseDate?: <internal>.Date

title

title: string

url

url: string

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/classes/_internal_.Duplex.html b/docs/classes/_internal_.Duplex.html similarity index 100% rename from gh-pages/classes/_internal_.Duplex.html rename to docs/classes/_internal_.Duplex.html diff --git a/gh-pages/classes/_internal_.EventEmitter-1.html b/docs/classes/_internal_.EventEmitter-1.html similarity index 100% rename from gh-pages/classes/_internal_.EventEmitter-1.html rename to docs/classes/_internal_.EventEmitter-1.html diff --git a/gh-pages/classes/_internal_.IncomingMessage.html b/docs/classes/_internal_.IncomingMessage.html similarity index 100% rename from gh-pages/classes/_internal_.IncomingMessage.html rename to docs/classes/_internal_.IncomingMessage.html diff --git a/gh-pages/classes/_internal_.LiveStreaming.html b/docs/classes/_internal_.LiveStreaming.html similarity index 94% rename from gh-pages/classes/_internal_.LiveStreaming.html rename to docs/classes/_internal_.LiveStreaming.html index 1a41c1b..03ebc89 100644 --- a/gh-pages/classes/_internal_.LiveStreaming.html +++ b/docs/classes/_internal_.LiveStreaming.html @@ -1 +1 @@ -LiveStreaming | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • LiveStreaming

Index

Constructors

constructor

  • new LiveStreaming(dash_url: string, target_interval: number, video_url: string): LiveStreaming

Properties

Private base_url

base_url: string

Private dash_timer

dash_timer: <internal>.Timer

Private interval

interval: number

Private packet_count

packet_count: number

Private request

request: null | IncomingMessage

Private segments_urls

segments_urls: string[]

stream

Private timer

type

Private url

url: string

Private video_url

video_url: string

Methods

Private cleanup

  • cleanup(): void

Private dash_getter

Private dash_updater

pause

  • pause(): void

resume

  • resume(): void

Private start

Generated using TypeDoc

\ No newline at end of file +LiveStreaming | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • LiveStreaming

Index

Constructors

constructor

  • new LiveStreaming(dash_url: string, target_interval: number, video_url: string): LiveStreaming

Properties

Private base_url

base_url: string

Private dash_timer

dash_timer: <internal>.Timer

Private interval

interval: number

Private packet_count

packet_count: number

Private request

request: null | IncomingMessage

Private segments_urls

segments_urls: string[]

stream

Private timer

type

Private url

url: string

Private video_url

video_url: string

Methods

Private cleanup

  • cleanup(): void

Private dash_getter

Private dash_updater

pause

  • pause(): void

resume

  • resume(): void

Private start

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/classes/_internal_.Readable.html b/docs/classes/_internal_.Readable.html similarity index 100% rename from gh-pages/classes/_internal_.Readable.html rename to docs/classes/_internal_.Readable.html diff --git a/gh-pages/classes/_internal_.Socket.html b/docs/classes/_internal_.Socket.html similarity index 100% rename from gh-pages/classes/_internal_.Socket.html rename to docs/classes/_internal_.Socket.html diff --git a/gh-pages/classes/_internal_.SoundCloudPlaylist.html b/docs/classes/_internal_.SoundCloudPlaylist.html similarity index 95% rename from gh-pages/classes/_internal_.SoundCloudPlaylist.html rename to docs/classes/_internal_.SoundCloudPlaylist.html index 66037d9..63a410f 100644 --- a/gh-pages/classes/_internal_.SoundCloudPlaylist.html +++ b/docs/classes/_internal_.SoundCloudPlaylist.html @@ -1,3 +1,3 @@ SoundCloudPlaylist | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SoundCloudPlaylist

SoundCloud Playlist

-

Hierarchy

  • SoundCloudPlaylist

Index

Constructors

constructor

Properties

client_id

client_id: string

durationInMs

durationInMs: number

durationInSec

durationInSec: number

id

id: number

name

name: string

sub_type

sub_type: string

tracks

tracksCount

tracksCount: number

type

type: "playlist" | "track" | "user"

url

url: string

user

Accessors

total_tracks

  • get total_tracks(): number

Methods

fetch

toJSON

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Constructors

constructor

Properties

client_id

client_id: string

durationInMs

durationInMs: number

durationInSec

durationInSec: number

id

id: number

name

name: string

sub_type

sub_type: string

tracks

tracksCount

tracksCount: number

type

type: "playlist" | "track" | "user"

url

url: string

user

Accessors

total_tracks

Methods

fetch

toJSON

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/classes/_internal_.SoundCloudTrack.html b/docs/classes/_internal_.SoundCloudTrack.html similarity index 96% rename from gh-pages/classes/_internal_.SoundCloudTrack.html rename to docs/classes/_internal_.SoundCloudTrack.html index f2a8ef3..3b86cff 100644 --- a/gh-pages/classes/_internal_.SoundCloudTrack.html +++ b/docs/classes/_internal_.SoundCloudTrack.html @@ -1,3 +1,3 @@ SoundCloudTrack | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

SoundCloud Track

-

Hierarchy

  • SoundCloudTrack

Index

Constructors

constructor

Properties

durationInMs

durationInMs: number

durationInSec

durationInSec: number

fetched

fetched: boolean

formats

id

id: number

name

name: string

publisher

publisher: null | { artist: string; contains_music: boolean; id: number; name: string; writer_composer: string }

thumbnail

thumbnail: string

type

type: "playlist" | "track" | "user"

url

url: string

user

Methods

toJSON

  • toJSON(): { durationInMs: number; durationInSec: number; fetched: boolean; formats: SoundCloudTrackFormat[]; id: number; name: string; publisher: null | { artist: string; contains_music: boolean; id: number; name: string; writer_composer: string }; thumbnail: string; type: "playlist" | "track" | "user"; url: string; user: SoundCloudUser }
  • Returns { durationInMs: number; durationInSec: number; fetched: boolean; formats: SoundCloudTrackFormat[]; id: number; name: string; publisher: null | { artist: string; contains_music: boolean; id: number; name: string; writer_composer: string }; thumbnail: string; type: "playlist" | "track" | "user"; url: string; user: SoundCloudUser }

    • durationInMs: number
    • durationInSec: number
    • fetched: boolean
    • formats: SoundCloudTrackFormat[]
    • id: number
    • name: string
    • publisher: null | { artist: string; contains_music: boolean; id: number; name: string; writer_composer: string }
    • thumbnail: string
    • type: "playlist" | "track" | "user"
    • url: string
    • user: SoundCloudUser

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Constructors

constructor

Properties

durationInMs

durationInMs: number

durationInSec

durationInSec: number

fetched

fetched: boolean

formats

id

id: number

name

name: string

publisher

publisher: null | { artist: string; contains_music: boolean; id: number; name: string; writer_composer: string }

thumbnail

thumbnail: string

type

type: "playlist" | "track" | "user"

url

url: string

user

Methods

toJSON

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/classes/_internal_.SpotifyAlbum.html b/docs/classes/_internal_.SpotifyAlbum.html similarity index 95% rename from gh-pages/classes/_internal_.SpotifyAlbum.html rename to docs/classes/_internal_.SpotifyAlbum.html index b70cb31..019cdd5 100644 --- a/gh-pages/classes/_internal_.SpotifyAlbum.html +++ b/docs/classes/_internal_.SpotifyAlbum.html @@ -1,3 +1,3 @@ SpotifyAlbum | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class for Spotify Album

-

Hierarchy

  • SpotifyAlbum

Index

Constructors

constructor

Properties

artists

artists: SpotifyArtists[]

copyrights

copyrights: SpotifyCopyright[]

Private fetched_tracks

fetched_tracks: <internal>.Map<string, SpotifyTrack[]>

id

id: string

name

name: string

release_date

release_date: string

release_date_precision

release_date_precision: string

Private spotifyData

spotifyData: SpotifyDataOptions

thumbnail

thumbnail: SpotifyThumbnail

tracksCount

tracksCount: number

type

type: "playlist" | "track" | "album"

url

url: string

Accessors

total_pages

  • get total_pages(): number

total_tracks

  • get total_tracks(): number

Methods

fetch

page

toJSON

  • toJSON(): { artists: SpotifyArtists[]; copyrights: SpotifyCopyright[]; name: string; release_date: string; release_date_precision: string; thumbnail: SpotifyThumbnail; total_tracks: number; type: "playlist" | "track" | "album"; url: string }

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Constructors

constructor

Properties

artists

artists: SpotifyArtists[]

copyrights

copyrights: SpotifyCopyright[]

Private fetched_tracks

fetched_tracks: <internal>.Map<string, SpotifyTrack[]>

id

id: string

name

name: string

release_date

release_date: string

release_date_precision

release_date_precision: string

Private spotifyData

spotifyData: SpotifyDataOptions

thumbnail

thumbnail: SpotifyThumbnail

tracksCount

tracksCount: number

type

type: "playlist" | "track" | "album"

url

url: string

Accessors

total_pages

total_tracks

Methods

fetch

page

toJSON

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/classes/_internal_.SpotifyPlaylist.html b/docs/classes/_internal_.SpotifyPlaylist.html similarity index 95% rename from gh-pages/classes/_internal_.SpotifyPlaylist.html rename to docs/classes/_internal_.SpotifyPlaylist.html index d940fd8..5451e2d 100644 --- a/gh-pages/classes/_internal_.SpotifyPlaylist.html +++ b/docs/classes/_internal_.SpotifyPlaylist.html @@ -1,3 +1,3 @@ SpotifyPlaylist | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class for Spotify Playlist

-

Hierarchy

  • SpotifyPlaylist

Index

Constructors

constructor

Properties

collaborative

collaborative: boolean

description

description: string

Private fetched_tracks

fetched_tracks: <internal>.Map<string, SpotifyTrack[]>

id

id: string

name

name: string

owner

Private spotifyData

spotifyData: SpotifyDataOptions

thumbnail

thumbnail: SpotifyThumbnail

tracksCount

tracksCount: number

type

type: "playlist" | "track" | "album"

url

url: string

Accessors

total_pages

  • get total_pages(): number

total_tracks

  • get total_tracks(): number

Methods

fetch

page

toJSON

  • toJSON(): { collaborative: boolean; description: string; id: string; name: string; owner: SpotifyArtists; thumbnail: SpotifyThumbnail; type: "playlist" | "track" | "album"; url: string }

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Constructors

constructor

Properties

collaborative

collaborative: boolean

description

description: string

Private fetched_tracks

fetched_tracks: <internal>.Map<string, SpotifyTrack[]>

id

id: string

name

name: string

owner

Private spotifyData

spotifyData: SpotifyDataOptions

thumbnail

thumbnail: SpotifyThumbnail

tracksCount

tracksCount: number

type

type: "playlist" | "track" | "album"

url

url: string

Accessors

total_pages

total_tracks

Methods

fetch

page

toJSON

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/classes/_internal_.SpotifyTrack.html b/docs/classes/_internal_.SpotifyTrack.html similarity index 95% rename from gh-pages/classes/_internal_.SpotifyTrack.html rename to docs/classes/_internal_.SpotifyTrack.html index 83baff3..86c9ee4 100644 --- a/gh-pages/classes/_internal_.SpotifyTrack.html +++ b/docs/classes/_internal_.SpotifyTrack.html @@ -1,3 +1,3 @@ SpotifyTrack | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class for Spotify Track

-

Hierarchy

  • SpotifyTrack

Index

Constructors

constructor

Properties

album

album: undefined | SpotifyTrackAlbum

artists

artists: SpotifyArtists[]

durationInMs

durationInMs: number

durationInSec

durationInSec: number

explicit

explicit: boolean

id

id: string

name

name: string

thumbnail

thumbnail: undefined | SpotifyThumbnail

type

type: "playlist" | "track" | "album"

url

url: string

Methods

toJSON

  • toJSON(): { album: undefined | SpotifyTrackAlbum; artists: SpotifyArtists[]; durationInMs: number; durationInSec: number; explicit: boolean; id: string; name: string; thumbnail: undefined | SpotifyThumbnail; type: "playlist" | "track" | "album"; url: string }

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Constructors

constructor

Properties

album

album: undefined | SpotifyTrackAlbum

artists

artists: SpotifyArtists[]

durationInMs

durationInMs: number

durationInSec

durationInSec: number

explicit

explicit: boolean

id

id: string

name

name: string

thumbnail

thumbnail: undefined | SpotifyThumbnail

type

type: "playlist" | "track" | "album"

url

url: string

Methods

toJSON

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/classes/_internal_.Stream-1.html b/docs/classes/_internal_.Stream-1.html similarity index 95% rename from gh-pages/classes/_internal_.Stream-1.html rename to docs/classes/_internal_.Stream-1.html index c5a28f3..19c68a9 100644 --- a/gh-pages/classes/_internal_.Stream-1.html +++ b/docs/classes/_internal_.Stream-1.html @@ -1,3 +1,3 @@ Stream | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

SoundCloud Stream class

-

Hierarchy

  • Stream

Index

Constructors

constructor

Properties

Private downloaded_segments

downloaded_segments: number

Private downloaded_time

downloaded_time: number

Private request

request: null | IncomingMessage

Private segment_urls

segment_urls: string[]

stream

Private time

time: number[]

Private timer

type

Private url

url: string

Methods

Private cleanup

  • cleanup(): void

Private loop

Private parser

pause

  • pause(): void

resume

  • resume(): void

Private start

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Constructors

constructor

Properties

Private downloaded_segments

downloaded_segments: number

Private downloaded_time

downloaded_time: number

Private request

request: null | IncomingMessage

Private segment_urls

segment_urls: string[]

stream

Private time

time: number[]

Private timer

type

Private url

url: string

Methods

Private cleanup

Private loop

Private parser

pause

resume

Private start

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/classes/_internal_.Stream-2.html b/docs/classes/_internal_.Stream-2.html similarity index 100% rename from gh-pages/classes/_internal_.Stream-2.html rename to docs/classes/_internal_.Stream-2.html diff --git a/gh-pages/classes/_internal_.Stream.html b/docs/classes/_internal_.Stream.html similarity index 95% rename from gh-pages/classes/_internal_.Stream.html rename to docs/classes/_internal_.Stream.html index 308d2bc..476b4c0 100644 --- a/gh-pages/classes/_internal_.Stream.html +++ b/docs/classes/_internal_.Stream.html @@ -1,3 +1,3 @@ Stream | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class for YouTube Stream

-

Hierarchy

  • Stream

Index

Constructors

constructor

Properties

Private bytes_count

bytes_count: number

Private content_length

content_length: number

Private per_sec_bytes

per_sec_bytes: number

Private proxy

proxy: undefined | ProxyOptions[]

Private quality

quality: number

Private request

request: null | IncomingMessage

stream

Private timer

type

Private url

url: string

Private video_url

video_url: string

Methods

Private cleanup

  • cleanup(): void

Private loop

pause

  • pause(): void

resume

  • resume(): void

Private retry

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Constructors

constructor

Properties

Private bytes_count

bytes_count: number

Private content_length

content_length: number

Private per_sec_bytes

per_sec_bytes: number

Private proxy

proxy: undefined | ProxyOptions[]

Private quality

quality: number

Private request

request: null | IncomingMessage

stream

Private timer

type

Private url

url: string

Private video_url

video_url: string

Methods

Private cleanup

Private loop

pause

resume

Private retry

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/classes/_internal_.Timer.html b/docs/classes/_internal_.Timer.html similarity index 95% rename from gh-pages/classes/_internal_.Timer.html rename to docs/classes/_internal_.Timer.html index 49abe69..79f9552 100644 --- a/gh-pages/classes/_internal_.Timer.html +++ b/docs/classes/_internal_.Timer.html @@ -1 +1 @@ -Timer | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Timer

Index

Constructors

constructor

Properties

Private callback

callback: () => void

Type declaration

    • (): void
    • Returns void

Private destroyed

destroyed: boolean

Private paused

paused: boolean

Private time_left

time_left: number

Private time_start

time_start: number

Private time_total

time_total: number

Private timer

Methods

destroy

  • destroy(): void

pause

  • pause(): boolean

resume

  • resume(): boolean

reuse

  • reuse(): boolean

Generated using TypeDoc

\ No newline at end of file +Timer | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Timer

Index

Constructors

constructor

Properties

Private callback

callback: () => void

Type declaration

    • (): void
    • Returns void

Private destroyed

destroyed: boolean

Private paused

paused: boolean

Private time_left

time_left: number

Private time_start

time_start: number

Private time_total

time_total: number

Private timer

Methods

destroy

  • destroy(): void

pause

  • pause(): boolean

resume

  • resume(): boolean

reuse

  • reuse(): boolean

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/classes/_internal_.YouTubeChannel.html b/docs/classes/_internal_.YouTubeChannel.html similarity index 96% rename from gh-pages/classes/_internal_.YouTubeChannel.html rename to docs/classes/_internal_.YouTubeChannel.html index ab65e07..6ec3337 100644 --- a/gh-pages/classes/_internal_.YouTubeChannel.html +++ b/docs/classes/_internal_.YouTubeChannel.html @@ -1,7 +1,7 @@ YouTubeChannel | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class for YouTube Channel url

-

Hierarchy

  • YouTubeChannel

Index

Constructors

constructor

Properties

Optional artist

artist?: boolean

Optional icon

Optional id

id?: string

Optional name

name?: string

Optional subscribers

subscribers?: string

type

type: "video" | "playlist" | "channel"

Optional url

url?: string

Optional verified

verified?: boolean

Methods

Private _patch

  • _patch(data: any): void

iconURL

  • iconURL(options?: { size: number }): undefined | string

Hierarchy

  • YouTubeChannel

Index

Constructors

constructor

Properties

Optional artist

artist?: boolean

Optional icon

Optional id

id?: string

Optional name

name?: string

Optional subscribers

subscribers?: string

type

type: "video" | "playlist" | "channel"

Optional url

url?: string

Optional verified

verified?: boolean

Methods

Private _patch

  • _patch(data: any): void

iconURL

  • iconURL(options?: { size: number }): undefined | string

toJSON

  • toJSON(): { artist: undefined | boolean; iconURL: undefined | string; id: undefined | string; name: undefined | string; subscribers: undefined | string; type: "video" | "playlist" | "channel"; url: undefined | string; verified: undefined | boolean }
  • Returns { artist: undefined | boolean; iconURL: undefined | string; id: undefined | string; name: undefined | string; subscribers: undefined | string; type: "video" | "playlist" | "channel"; url: undefined | string; verified: undefined | boolean }

    • artist: undefined | boolean
    • iconURL: undefined | string
    • id: undefined | string
    • name: undefined | string
    • subscribers: undefined | string
    • type: "video" | "playlist" | "channel"
    • url: undefined | string
    • verified: undefined | boolean

toString

  • toString(): string

Generated using TypeDoc

\ No newline at end of file +

Returns undefined | string

toJSON

toString

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/classes/_internal_.YouTubePlayList.html b/docs/classes/_internal_.YouTubePlayList.html similarity index 96% rename from gh-pages/classes/_internal_.YouTubePlayList.html rename to docs/classes/_internal_.YouTubePlayList.html index b2f3600..36812da 100644 --- a/gh-pages/classes/_internal_.YouTubePlayList.html +++ b/docs/classes/_internal_.YouTubePlayList.html @@ -1,3 +1,3 @@ YouTubePlayList | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class for YouTube Playlist url

-

Hierarchy

  • YouTubePlayList

Index

Constructors

constructor

Properties

Private __count

__count: number

Private _continuation

_continuation: { api?: string; clientVersion?: string; token?: string } = {}

Type declaration

  • Optional api?: string
  • Optional clientVersion?: string
  • Optional token?: string

Optional channel

channel?: YouTubeChannel

Private fetched_videos

fetched_videos: <internal>.Map<string, YouTubeVideo[]>

Optional id

id?: string

Optional lastUpdate

lastUpdate?: string

Optional link

link?: string

Optional thumbnail

thumbnail?: { height: undefined | number; id: undefined | string; url: undefined | string; width: undefined | number }

Type declaration

  • height: undefined | number
  • id: undefined | string
  • url: undefined | string
  • width: undefined | number

Optional title

title?: string

type

type: "video" | "playlist" | "channel"

Optional url

url?: string

Optional videoCount

videoCount?: number

Private Optional videos

videos?: []

Optional views

views?: number

Accessors

total_pages

  • get total_pages(): number

total_videos

  • get total_videos(): number

Methods

Private __patch

  • __patch(data: any): void

Private __patchSearch

  • __patchSearch(data: any): void

fetch

next

page

toJSON

  • toJSON(): { channel: { icon: undefined | string; id: undefined | string; name: undefined | string }; id: undefined | string; thumbnail: undefined | { height: undefined | number; id: undefined | string; url: undefined | string; width: undefined | number }; title: undefined | string; url: undefined | string; videos: undefined | [] }
  • Returns { channel: { icon: undefined | string; id: undefined | string; name: undefined | string }; id: undefined | string; thumbnail: undefined | { height: undefined | number; id: undefined | string; url: undefined | string; width: undefined | number }; title: undefined | string; url: undefined | string; videos: undefined | [] }

    • channel: { icon: undefined | string; id: undefined | string; name: undefined | string }
      • icon: undefined | string
      • id: undefined | string
      • name: undefined | string
    • id: undefined | string
    • thumbnail: undefined | { height: undefined | number; id: undefined | string; url: undefined | string; width: undefined | number }
    • title: undefined | string
    • url: undefined | string
    • videos: undefined | []

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Constructors

constructor

Properties

Private __count

__count: number

Private _continuation

_continuation: { api?: string; clientVersion?: string; token?: string } = {}

Type declaration

  • Optional api?: string
  • Optional clientVersion?: string
  • Optional token?: string

Optional channel

channel?: YouTubeChannel

Private fetched_videos

fetched_videos: <internal>.Map<string, YouTubeVideo[]>

Optional id

id?: string

Optional lastUpdate

lastUpdate?: string

Optional link

link?: string

Optional thumbnail

thumbnail?: { height: undefined | number; id: undefined | string; url: undefined | string; width: undefined | number }

Type declaration

  • height: undefined | number
  • id: undefined | string
  • url: undefined | string
  • width: undefined | number

Optional title

title?: string

type

type: "video" | "playlist" | "channel"

Optional url

url?: string

Optional videoCount

videoCount?: number

Private Optional videos

videos?: []

Optional views

views?: number

Accessors

total_pages

total_videos

Methods

Private __patch

Private __patchSearch

fetch

next

page

toJSON

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/classes/_internal_.YouTubeVideo.html b/docs/classes/_internal_.YouTubeVideo.html similarity index 94% rename from gh-pages/classes/_internal_.YouTubeVideo.html rename to docs/classes/_internal_.YouTubeVideo.html index 310573e..ace2853 100644 --- a/gh-pages/classes/_internal_.YouTubeVideo.html +++ b/docs/classes/_internal_.YouTubeVideo.html @@ -1,3 +1,3 @@ YouTubeVideo | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class for YouTube Video url

-

Hierarchy

  • YouTubeVideo

Index

Constructors

constructor

Properties

Optional channel

channel?: YouTubeChannel

Optional description

description?: string

dislikes

dislikes: number

durationInSec

durationInSec: number

durationRaw

durationRaw: string

Optional id

id?: string

likes

likes: number

live

live: boolean

private

private: boolean

tags

tags: string[]

Optional thumbnail

thumbnail?: { height: undefined | number; id: undefined | string; url: undefined | string; width: undefined | number }

Type declaration

  • height: undefined | number
  • id: undefined | string
  • url: undefined | string
  • width: undefined | number

Optional title

title?: string

type

type: "video" | "playlist" | "channel"

Optional uploadedAt

uploadedAt?: string

url

url: string

views

views: number

Accessors

toJSON

toString

  • get toString(): string

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Constructors

constructor

Properties

Optional channel

channel?: YouTubeChannel

Optional description

description?: string

dislikes

dislikes: number

durationInSec

durationInSec: number

durationRaw

durationRaw: string

Optional id

id?: string

likes

likes: number

live

live: boolean

private

private: boolean

tags

tags: string[]

Optional thumbnail

thumbnail?: { height: undefined | number; id: undefined | string; url: undefined | string; width: undefined | number }

Type declaration

  • height: undefined | number
  • id: undefined | string
  • url: undefined | string
  • width: undefined | number

Optional title

title?: string

type

type: "video" | "playlist" | "channel"

Optional uploadedAt

uploadedAt?: string

url

url: string

views

views: number

Accessors

toJSON

toString

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/classes/_internal_.internal-1.html b/docs/classes/_internal_.internal-1.html similarity index 100% rename from gh-pages/classes/_internal_.internal-1.html rename to docs/classes/_internal_.internal-1.html diff --git a/gh-pages/classes/_internal_.internal.Duplex.html b/docs/classes/_internal_.internal.Duplex.html similarity index 100% rename from gh-pages/classes/_internal_.internal.Duplex.html rename to docs/classes/_internal_.internal.Duplex.html diff --git a/gh-pages/classes/_internal_.internal.PassThrough.html b/docs/classes/_internal_.internal.PassThrough.html similarity index 100% rename from gh-pages/classes/_internal_.internal.PassThrough.html rename to docs/classes/_internal_.internal.PassThrough.html diff --git a/gh-pages/classes/_internal_.internal.Readable.html b/docs/classes/_internal_.internal.Readable.html similarity index 100% rename from gh-pages/classes/_internal_.internal.Readable.html rename to docs/classes/_internal_.internal.Readable.html diff --git a/gh-pages/classes/_internal_.internal.Stream.html b/docs/classes/_internal_.internal.Stream.html similarity index 100% rename from gh-pages/classes/_internal_.internal.Stream.html rename to docs/classes/_internal_.internal.Stream.html diff --git a/gh-pages/classes/_internal_.internal.Transform.html b/docs/classes/_internal_.internal.Transform.html similarity index 100% rename from gh-pages/classes/_internal_.internal.Transform.html rename to docs/classes/_internal_.internal.Transform.html diff --git a/gh-pages/classes/_internal_.internal.Writable.html b/docs/classes/_internal_.internal.Writable.html similarity index 100% rename from gh-pages/classes/_internal_.internal.Writable.html rename to docs/classes/_internal_.internal.Writable.html diff --git a/gh-pages/enums/_internal_.StreamType.html b/docs/enums/_internal_.StreamType.html similarity index 95% rename from gh-pages/enums/_internal_.StreamType.html rename to docs/enums/_internal_.StreamType.html index 14927cd..93c91a4 100644 --- a/gh-pages/enums/_internal_.StreamType.html +++ b/docs/enums/_internal_.StreamType.html @@ -1 +1 @@ -StreamType | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration StreamType

Index

Enumeration members

Arbitrary

Arbitrary = "arbitrary"

OggOpus

OggOpus = "ogg/opus"

Opus

Opus = "opus"

Raw

Raw = "raw"

WebmOpus

WebmOpus = "webm/opus"

Generated using TypeDoc

\ No newline at end of file +StreamType | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration StreamType

Index

Enumeration members

Arbitrary

Arbitrary = "arbitrary"

OggOpus

OggOpus = "ogg/opus"

Opus

Opus = "opus"

Raw

Raw = "raw"

WebmOpus

WebmOpus = "webm/opus"

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/index.html b/docs/index.html similarity index 100% rename from gh-pages/index.html rename to docs/index.html diff --git a/gh-pages/interfaces/_internal_.AbortSignal.html b/docs/interfaces/_internal_.AbortSignal.html similarity index 100% rename from gh-pages/interfaces/_internal_.AbortSignal.html rename to docs/interfaces/_internal_.AbortSignal.html diff --git a/gh-pages/interfaces/_internal_.AddressInfo.html b/docs/interfaces/_internal_.AddressInfo.html similarity index 100% rename from gh-pages/interfaces/_internal_.AddressInfo.html rename to docs/interfaces/_internal_.AddressInfo.html diff --git a/gh-pages/interfaces/_internal_.ArrayBuffer.html b/docs/interfaces/_internal_.ArrayBuffer.html similarity index 100% rename from gh-pages/interfaces/_internal_.ArrayBuffer.html rename to docs/interfaces/_internal_.ArrayBuffer.html diff --git a/gh-pages/interfaces/_internal_.ArrayBufferConstructor.html b/docs/interfaces/_internal_.ArrayBufferConstructor.html similarity index 100% rename from gh-pages/interfaces/_internal_.ArrayBufferConstructor.html rename to docs/interfaces/_internal_.ArrayBufferConstructor.html diff --git a/gh-pages/interfaces/_internal_.ArrayBufferTypes.html b/docs/interfaces/_internal_.ArrayBufferTypes.html similarity index 100% rename from gh-pages/interfaces/_internal_.ArrayBufferTypes.html rename to docs/interfaces/_internal_.ArrayBufferTypes.html diff --git a/gh-pages/interfaces/_internal_.ArrayBufferView.html b/docs/interfaces/_internal_.ArrayBufferView.html similarity index 100% rename from gh-pages/interfaces/_internal_.ArrayBufferView.html rename to docs/interfaces/_internal_.ArrayBufferView.html diff --git a/gh-pages/interfaces/_internal_.ArrayLike.html b/docs/interfaces/_internal_.ArrayLike.html similarity index 100% rename from gh-pages/interfaces/_internal_.ArrayLike.html rename to docs/interfaces/_internal_.ArrayLike.html diff --git a/gh-pages/interfaces/_internal_.AsyncGenerator.html b/docs/interfaces/_internal_.AsyncGenerator.html similarity index 100% rename from gh-pages/interfaces/_internal_.AsyncGenerator.html rename to docs/interfaces/_internal_.AsyncGenerator.html diff --git a/gh-pages/interfaces/_internal_.AsyncGeneratorFunction.html b/docs/interfaces/_internal_.AsyncGeneratorFunction.html similarity index 100% rename from gh-pages/interfaces/_internal_.AsyncGeneratorFunction.html rename to docs/interfaces/_internal_.AsyncGeneratorFunction.html diff --git a/gh-pages/interfaces/_internal_.AsyncIterable.html b/docs/interfaces/_internal_.AsyncIterable.html similarity index 100% rename from gh-pages/interfaces/_internal_.AsyncIterable.html rename to docs/interfaces/_internal_.AsyncIterable.html diff --git a/gh-pages/interfaces/_internal_.AsyncIterableIterator.html b/docs/interfaces/_internal_.AsyncIterableIterator.html similarity index 100% rename from gh-pages/interfaces/_internal_.AsyncIterableIterator.html rename to docs/interfaces/_internal_.AsyncIterableIterator.html diff --git a/gh-pages/interfaces/_internal_.AsyncIterator.html b/docs/interfaces/_internal_.AsyncIterator.html similarity index 100% rename from gh-pages/interfaces/_internal_.AsyncIterator.html rename to docs/interfaces/_internal_.AsyncIterator.html diff --git a/gh-pages/interfaces/_internal_.BigInt64Array.html b/docs/interfaces/_internal_.BigInt64Array.html similarity index 100% rename from gh-pages/interfaces/_internal_.BigInt64Array.html rename to docs/interfaces/_internal_.BigInt64Array.html diff --git a/gh-pages/interfaces/_internal_.BigInt64ArrayConstructor.html b/docs/interfaces/_internal_.BigInt64ArrayConstructor.html similarity index 100% rename from gh-pages/interfaces/_internal_.BigInt64ArrayConstructor.html rename to docs/interfaces/_internal_.BigInt64ArrayConstructor.html diff --git a/gh-pages/interfaces/_internal_.BigUint64Array.html b/docs/interfaces/_internal_.BigUint64Array.html similarity index 100% rename from gh-pages/interfaces/_internal_.BigUint64Array.html rename to docs/interfaces/_internal_.BigUint64Array.html diff --git a/gh-pages/interfaces/_internal_.BigUint64ArrayConstructor.html b/docs/interfaces/_internal_.BigUint64ArrayConstructor.html similarity index 100% rename from gh-pages/interfaces/_internal_.BigUint64ArrayConstructor.html rename to docs/interfaces/_internal_.BigUint64ArrayConstructor.html diff --git a/gh-pages/interfaces/_internal_.Blob.html b/docs/interfaces/_internal_.Blob.html similarity index 100% rename from gh-pages/interfaces/_internal_.Blob.html rename to docs/interfaces/_internal_.Blob.html diff --git a/gh-pages/interfaces/_internal_.Buffer.html b/docs/interfaces/_internal_.Buffer.html similarity index 100% rename from gh-pages/interfaces/_internal_.Buffer.html rename to docs/interfaces/_internal_.Buffer.html diff --git a/gh-pages/interfaces/_internal_.BufferConstructor.html b/docs/interfaces/_internal_.BufferConstructor.html similarity index 100% rename from gh-pages/interfaces/_internal_.BufferConstructor.html rename to docs/interfaces/_internal_.BufferConstructor.html diff --git a/gh-pages/interfaces/_internal_.CallSite.html b/docs/interfaces/_internal_.CallSite.html similarity index 100% rename from gh-pages/interfaces/_internal_.CallSite.html rename to docs/interfaces/_internal_.CallSite.html diff --git a/gh-pages/interfaces/_internal_.ChannelIconInterface.html b/docs/interfaces/_internal_.ChannelIconInterface.html similarity index 95% rename from gh-pages/interfaces/_internal_.ChannelIconInterface.html rename to docs/interfaces/_internal_.ChannelIconInterface.html index d9a6993..3aa6f84 100644 --- a/gh-pages/interfaces/_internal_.ChannelIconInterface.html +++ b/docs/interfaces/_internal_.ChannelIconInterface.html @@ -1 +1 @@ -ChannelIconInterface | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ChannelIconInterface

Hierarchy

  • ChannelIconInterface

Index

Properties

Properties

height

height: number

Optional url

url?: string

width

width: number

Generated using TypeDoc

\ No newline at end of file +ChannelIconInterface | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ChannelIconInterface

Hierarchy

  • ChannelIconInterface

Index

Properties

Properties

height

height: number

Optional url

url?: string

width

width: number

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/interfaces/_internal_.ConnectOpts.html b/docs/interfaces/_internal_.ConnectOpts.html similarity index 100% rename from gh-pages/interfaces/_internal_.ConnectOpts.html rename to docs/interfaces/_internal_.ConnectOpts.html diff --git a/gh-pages/interfaces/_internal_.DOMEventTarget.html b/docs/interfaces/_internal_.DOMEventTarget.html similarity index 100% rename from gh-pages/interfaces/_internal_.DOMEventTarget.html rename to docs/interfaces/_internal_.DOMEventTarget.html diff --git a/gh-pages/interfaces/_internal_.DataView.html b/docs/interfaces/_internal_.DataView.html similarity index 100% rename from gh-pages/interfaces/_internal_.DataView.html rename to docs/interfaces/_internal_.DataView.html diff --git a/gh-pages/interfaces/_internal_.DataViewConstructor.html b/docs/interfaces/_internal_.DataViewConstructor.html similarity index 100% rename from gh-pages/interfaces/_internal_.DataViewConstructor.html rename to docs/interfaces/_internal_.DataViewConstructor.html diff --git a/gh-pages/interfaces/_internal_.Date.html b/docs/interfaces/_internal_.Date.html similarity index 100% rename from gh-pages/interfaces/_internal_.Date.html rename to docs/interfaces/_internal_.Date.html diff --git a/gh-pages/interfaces/_internal_.DateConstructor.html b/docs/interfaces/_internal_.DateConstructor.html similarity index 100% rename from gh-pages/interfaces/_internal_.DateConstructor.html rename to docs/interfaces/_internal_.DateConstructor.html diff --git a/gh-pages/interfaces/_internal_.DateTimeFormatOptions.html b/docs/interfaces/_internal_.DateTimeFormatOptions.html similarity index 100% rename from gh-pages/interfaces/_internal_.DateTimeFormatOptions.html rename to docs/interfaces/_internal_.DateTimeFormatOptions.html diff --git a/gh-pages/interfaces/_internal_.DeezerAdvancedSearchOptions.html b/docs/interfaces/_internal_.DeezerAdvancedSearchOptions.html similarity index 95% rename from gh-pages/interfaces/_internal_.DeezerAdvancedSearchOptions.html rename to docs/interfaces/_internal_.DeezerAdvancedSearchOptions.html index d6db92f..d759b4f 100644 --- a/gh-pages/interfaces/_internal_.DeezerAdvancedSearchOptions.html +++ b/docs/interfaces/_internal_.DeezerAdvancedSearchOptions.html @@ -1 +1 @@ -DeezerAdvancedSearchOptions | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DeezerAdvancedSearchOptions

Hierarchy

  • DeezerAdvancedSearchOptions

Index

Properties

Optional album

album?: string

Optional artist

artist?: string

Optional label

label?: string

Optional limit

limit?: number

Optional maxBPM

maxBPM?: number

Optional maxDurationInSec

maxDurationInSec?: number

Optional minBPM

minBPM?: number

Optional minDurationInSec

minDurationInSec?: number

Optional title

title?: string

Generated using TypeDoc

\ No newline at end of file +DeezerAdvancedSearchOptions | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DeezerAdvancedSearchOptions

Hierarchy

  • DeezerAdvancedSearchOptions

Index

Properties

Optional album

album?: string

Optional artist

artist?: string

Optional label

label?: string

Optional limit

limit?: number

Optional maxBPM

maxBPM?: number

Optional maxDurationInSec

maxDurationInSec?: number

Optional minBPM

minBPM?: number

Optional minDurationInSec

minDurationInSec?: number

Optional title

title?: string

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/interfaces/_internal_.DeezerGenre.html b/docs/interfaces/_internal_.DeezerGenre.html similarity index 95% rename from gh-pages/interfaces/_internal_.DeezerGenre.html rename to docs/interfaces/_internal_.DeezerGenre.html index 3c139a4..f141f7c 100644 --- a/gh-pages/interfaces/_internal_.DeezerGenre.html +++ b/docs/interfaces/_internal_.DeezerGenre.html @@ -1 +1 @@ -DeezerGenre | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DeezerGenre

Hierarchy

  • DeezerGenre

Index

Properties

Properties

name

name: string

picture

picture: DeezerImage

Generated using TypeDoc

\ No newline at end of file +DeezerGenre | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DeezerGenre

Hierarchy

  • DeezerGenre

Index

Properties

Properties

name

name: string

picture

picture: DeezerImage

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/interfaces/_internal_.DeezerImage.html b/docs/interfaces/_internal_.DeezerImage.html similarity index 96% rename from gh-pages/interfaces/_internal_.DeezerImage.html rename to docs/interfaces/_internal_.DeezerImage.html index 0dbb714..50b67f9 100644 --- a/gh-pages/interfaces/_internal_.DeezerImage.html +++ b/docs/interfaces/_internal_.DeezerImage.html @@ -1 +1 @@ -DeezerImage | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DeezerImage

Hierarchy

  • DeezerImage

Index

Properties

big

big: string

medium

medium: string

small

small: string

xl

xl: string

Generated using TypeDoc

\ No newline at end of file +DeezerImage | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DeezerImage

Hierarchy

  • DeezerImage

Index

Properties

big

big: string

medium

medium: string

small

small: string

xl

xl: string

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/interfaces/_internal_.DeezerSearchOptions.html b/docs/interfaces/_internal_.DeezerSearchOptions.html similarity index 96% rename from gh-pages/interfaces/_internal_.DeezerSearchOptions.html rename to docs/interfaces/_internal_.DeezerSearchOptions.html index 3ee7490..86c8e1c 100644 --- a/gh-pages/interfaces/_internal_.DeezerSearchOptions.html +++ b/docs/interfaces/_internal_.DeezerSearchOptions.html @@ -1 +1 @@ -DeezerSearchOptions | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DeezerSearchOptions

Hierarchy

  • DeezerSearchOptions

Index

Properties

Properties

Optional fuzzy

fuzzy?: boolean

Optional limit

limit?: number

Optional type

type?: "playlist" | "track" | "album"

Generated using TypeDoc

\ No newline at end of file +DeezerSearchOptions | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DeezerSearchOptions

Hierarchy

  • DeezerSearchOptions

Index

Properties

Properties

Optional fuzzy

fuzzy?: boolean

Optional limit

limit?: number

Optional type

type?: "playlist" | "track" | "album"

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/interfaces/_internal_.DeezerUser.html b/docs/interfaces/_internal_.DeezerUser.html similarity index 97% rename from gh-pages/interfaces/_internal_.DeezerUser.html rename to docs/interfaces/_internal_.DeezerUser.html index a4dc401..c5622ca 100644 --- a/gh-pages/interfaces/_internal_.DeezerUser.html +++ b/docs/interfaces/_internal_.DeezerUser.html @@ -1 +1 @@ -DeezerUser | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DeezerUser

Hierarchy

  • DeezerUser

Index

Properties

Properties

id

id: number

name

name: string

Generated using TypeDoc

\ No newline at end of file +DeezerUser | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DeezerUser

Hierarchy

  • DeezerUser

Index

Properties

Properties

id

id: number

name

name: string

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/interfaces/_internal_.Dict.html b/docs/interfaces/_internal_.Dict.html similarity index 100% rename from gh-pages/interfaces/_internal_.Dict.html rename to docs/interfaces/_internal_.Dict.html diff --git a/gh-pages/interfaces/_internal_.ErrnoException.html b/docs/interfaces/_internal_.ErrnoException.html similarity index 100% rename from gh-pages/interfaces/_internal_.ErrnoException.html rename to docs/interfaces/_internal_.ErrnoException.html diff --git a/gh-pages/interfaces/_internal_.Error.html b/docs/interfaces/_internal_.Error.html similarity index 100% rename from gh-pages/interfaces/_internal_.Error.html rename to docs/interfaces/_internal_.Error.html diff --git a/gh-pages/interfaces/_internal_.ErrorConstructor.html b/docs/interfaces/_internal_.ErrorConstructor.html similarity index 100% rename from gh-pages/interfaces/_internal_.ErrorConstructor.html rename to docs/interfaces/_internal_.ErrorConstructor.html diff --git a/gh-pages/interfaces/_internal_.EventEmitter-2.html b/docs/interfaces/_internal_.EventEmitter-2.html similarity index 100% rename from gh-pages/interfaces/_internal_.EventEmitter-2.html rename to docs/interfaces/_internal_.EventEmitter-2.html diff --git a/gh-pages/interfaces/_internal_.EventEmitter.Abortable.html b/docs/interfaces/_internal_.EventEmitter.Abortable.html similarity index 100% rename from gh-pages/interfaces/_internal_.EventEmitter.Abortable.html rename to docs/interfaces/_internal_.EventEmitter.Abortable.html diff --git a/gh-pages/interfaces/_internal_.EventEmitterOptions.html b/docs/interfaces/_internal_.EventEmitterOptions.html similarity index 100% rename from gh-pages/interfaces/_internal_.EventEmitterOptions.html rename to docs/interfaces/_internal_.EventEmitterOptions.html diff --git a/gh-pages/interfaces/_internal_.Float32Array.html b/docs/interfaces/_internal_.Float32Array.html similarity index 100% rename from gh-pages/interfaces/_internal_.Float32Array.html rename to docs/interfaces/_internal_.Float32Array.html diff --git a/gh-pages/interfaces/_internal_.Float32ArrayConstructor.html b/docs/interfaces/_internal_.Float32ArrayConstructor.html similarity index 100% rename from gh-pages/interfaces/_internal_.Float32ArrayConstructor.html rename to docs/interfaces/_internal_.Float32ArrayConstructor.html diff --git a/gh-pages/interfaces/_internal_.Float64Array.html b/docs/interfaces/_internal_.Float64Array.html similarity index 100% rename from gh-pages/interfaces/_internal_.Float64Array.html rename to docs/interfaces/_internal_.Float64Array.html diff --git a/gh-pages/interfaces/_internal_.Float64ArrayConstructor.html b/docs/interfaces/_internal_.Float64ArrayConstructor.html similarity index 100% rename from gh-pages/interfaces/_internal_.Float64ArrayConstructor.html rename to docs/interfaces/_internal_.Float64ArrayConstructor.html diff --git a/gh-pages/interfaces/_internal_.Function.html b/docs/interfaces/_internal_.Function.html similarity index 100% rename from gh-pages/interfaces/_internal_.Function.html rename to docs/interfaces/_internal_.Function.html diff --git a/gh-pages/interfaces/_internal_.FunctionConstructor.html b/docs/interfaces/_internal_.FunctionConstructor.html similarity index 100% rename from gh-pages/interfaces/_internal_.FunctionConstructor.html rename to docs/interfaces/_internal_.FunctionConstructor.html diff --git a/gh-pages/interfaces/_internal_.IncomingHttpHeaders.html b/docs/interfaces/_internal_.IncomingHttpHeaders.html similarity index 100% rename from gh-pages/interfaces/_internal_.IncomingHttpHeaders.html rename to docs/interfaces/_internal_.IncomingHttpHeaders.html diff --git a/gh-pages/interfaces/_internal_.InfoData.html b/docs/interfaces/_internal_.InfoData.html similarity index 97% rename from gh-pages/interfaces/_internal_.InfoData.html rename to docs/interfaces/_internal_.InfoData.html index 3f98259..9717501 100644 --- a/gh-pages/interfaces/_internal_.InfoData.html +++ b/docs/interfaces/_internal_.InfoData.html @@ -1 +1 @@ -InfoData | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InfoData

Hierarchy

  • InfoData

Index

Properties

LiveStreamData

LiveStreamData: { dashManifestUrl: string; hlsManifestUrl: string; isLive: boolean }

Type declaration

  • dashManifestUrl: string
  • hlsManifestUrl: string
  • isLive: boolean

format

format: any[]

html5player

html5player: string

video_details

video_details: any

Generated using TypeDoc

\ No newline at end of file +InfoData | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InfoData

Hierarchy

  • InfoData

Index

Properties

LiveStreamData

LiveStreamData: { dashManifestUrl: string; hlsManifestUrl: string; isLive: boolean }

Type declaration

  • dashManifestUrl: string
  • hlsManifestUrl: string
  • isLive: boolean

format

format: any[]

html5player

html5player: string

video_details

video_details: any

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/interfaces/_internal_.InfoOptions.html b/docs/interfaces/_internal_.InfoOptions.html similarity index 97% rename from gh-pages/interfaces/_internal_.InfoOptions.html rename to docs/interfaces/_internal_.InfoOptions.html index 7cfb044..64e1b48 100644 --- a/gh-pages/interfaces/_internal_.InfoOptions.html +++ b/docs/interfaces/_internal_.InfoOptions.html @@ -1 +1 @@ -InfoOptions | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InfoOptions

Hierarchy

  • InfoOptions

Index

Properties

Properties

Optional htmldata

htmldata?: boolean

Optional proxy

proxy?: ProxyOptions[]

Generated using TypeDoc

\ No newline at end of file +InfoOptions | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InfoOptions

Hierarchy

  • InfoOptions

Index

Properties

Properties

Optional htmldata

htmldata?: boolean

Optional proxy

proxy?: ProxyOptions[]

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/interfaces/_internal_.Int16Array.html b/docs/interfaces/_internal_.Int16Array.html similarity index 100% rename from gh-pages/interfaces/_internal_.Int16Array.html rename to docs/interfaces/_internal_.Int16Array.html diff --git a/gh-pages/interfaces/_internal_.Int16ArrayConstructor.html b/docs/interfaces/_internal_.Int16ArrayConstructor.html similarity index 100% rename from gh-pages/interfaces/_internal_.Int16ArrayConstructor.html rename to docs/interfaces/_internal_.Int16ArrayConstructor.html diff --git a/gh-pages/interfaces/_internal_.Int32Array.html b/docs/interfaces/_internal_.Int32Array.html similarity index 100% rename from gh-pages/interfaces/_internal_.Int32Array.html rename to docs/interfaces/_internal_.Int32Array.html diff --git a/gh-pages/interfaces/_internal_.Int32ArrayConstructor.html b/docs/interfaces/_internal_.Int32ArrayConstructor.html similarity index 100% rename from gh-pages/interfaces/_internal_.Int32ArrayConstructor.html rename to docs/interfaces/_internal_.Int32ArrayConstructor.html diff --git a/gh-pages/interfaces/_internal_.Int8Array.html b/docs/interfaces/_internal_.Int8Array.html similarity index 100% rename from gh-pages/interfaces/_internal_.Int8Array.html rename to docs/interfaces/_internal_.Int8Array.html diff --git a/gh-pages/interfaces/_internal_.Int8ArrayConstructor.html b/docs/interfaces/_internal_.Int8ArrayConstructor.html similarity index 100% rename from gh-pages/interfaces/_internal_.Int8ArrayConstructor.html rename to docs/interfaces/_internal_.Int8ArrayConstructor.html diff --git a/gh-pages/interfaces/_internal_.IpcSocketConnectOpts.html b/docs/interfaces/_internal_.IpcSocketConnectOpts.html similarity index 100% rename from gh-pages/interfaces/_internal_.IpcSocketConnectOpts.html rename to docs/interfaces/_internal_.IpcSocketConnectOpts.html diff --git a/gh-pages/interfaces/_internal_.Iterable.html b/docs/interfaces/_internal_.Iterable.html similarity index 100% rename from gh-pages/interfaces/_internal_.Iterable.html rename to docs/interfaces/_internal_.Iterable.html diff --git a/gh-pages/interfaces/_internal_.IterableIterator.html b/docs/interfaces/_internal_.IterableIterator.html similarity index 100% rename from gh-pages/interfaces/_internal_.IterableIterator.html rename to docs/interfaces/_internal_.IterableIterator.html diff --git a/gh-pages/interfaces/_internal_.Iterator.html b/docs/interfaces/_internal_.Iterator.html similarity index 100% rename from gh-pages/interfaces/_internal_.Iterator.html rename to docs/interfaces/_internal_.Iterator.html diff --git a/gh-pages/interfaces/_internal_.IteratorReturnResult.html b/docs/interfaces/_internal_.IteratorReturnResult.html similarity index 100% rename from gh-pages/interfaces/_internal_.IteratorReturnResult.html rename to docs/interfaces/_internal_.IteratorReturnResult.html diff --git a/gh-pages/interfaces/_internal_.IteratorYieldResult.html b/docs/interfaces/_internal_.IteratorYieldResult.html similarity index 100% rename from gh-pages/interfaces/_internal_.IteratorYieldResult.html rename to docs/interfaces/_internal_.IteratorYieldResult.html diff --git a/gh-pages/interfaces/_internal_.LookupOneOptions.html b/docs/interfaces/_internal_.LookupOneOptions.html similarity index 100% rename from gh-pages/interfaces/_internal_.LookupOneOptions.html rename to docs/interfaces/_internal_.LookupOneOptions.html diff --git a/gh-pages/interfaces/_internal_.LookupOptions.html b/docs/interfaces/_internal_.LookupOptions.html similarity index 100% rename from gh-pages/interfaces/_internal_.LookupOptions.html rename to docs/interfaces/_internal_.LookupOptions.html diff --git a/gh-pages/interfaces/_internal_.Map.html b/docs/interfaces/_internal_.Map.html similarity index 100% rename from gh-pages/interfaces/_internal_.Map.html rename to docs/interfaces/_internal_.Map.html diff --git a/gh-pages/interfaces/_internal_.MapConstructor.html b/docs/interfaces/_internal_.MapConstructor.html similarity index 100% rename from gh-pages/interfaces/_internal_.MapConstructor.html rename to docs/interfaces/_internal_.MapConstructor.html diff --git a/gh-pages/interfaces/_internal_.NodeEventTarget.html b/docs/interfaces/_internal_.NodeEventTarget.html similarity index 100% rename from gh-pages/interfaces/_internal_.NodeEventTarget.html rename to docs/interfaces/_internal_.NodeEventTarget.html diff --git a/gh-pages/interfaces/_internal_.Object.html b/docs/interfaces/_internal_.Object.html similarity index 100% rename from gh-pages/interfaces/_internal_.Object.html rename to docs/interfaces/_internal_.Object.html diff --git a/gh-pages/interfaces/_internal_.ObjectConstructor.html b/docs/interfaces/_internal_.ObjectConstructor.html similarity index 100% rename from gh-pages/interfaces/_internal_.ObjectConstructor.html rename to docs/interfaces/_internal_.ObjectConstructor.html diff --git a/gh-pages/interfaces/_internal_.OnReadOpts.html b/docs/interfaces/_internal_.OnReadOpts.html similarity index 100% rename from gh-pages/interfaces/_internal_.OnReadOpts.html rename to docs/interfaces/_internal_.OnReadOpts.html diff --git a/gh-pages/interfaces/_internal_.PlaylistOptions.html b/docs/interfaces/_internal_.PlaylistOptions.html similarity index 97% rename from gh-pages/interfaces/_internal_.PlaylistOptions.html rename to docs/interfaces/_internal_.PlaylistOptions.html index 3924958..d488c23 100644 --- a/gh-pages/interfaces/_internal_.PlaylistOptions.html +++ b/docs/interfaces/_internal_.PlaylistOptions.html @@ -1 +1 @@ -PlaylistOptions | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PlaylistOptions

Hierarchy

  • PlaylistOptions

Index

Properties

Properties

Optional incomplete

incomplete?: boolean

Optional proxy

proxy?: ProxyOptions[]

Generated using TypeDoc

\ No newline at end of file +PlaylistOptions | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PlaylistOptions

Hierarchy

  • PlaylistOptions

Index

Properties

Properties

Optional incomplete

incomplete?: boolean

Optional proxy

proxy?: ProxyOptions[]

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/interfaces/_internal_.Promise.html b/docs/interfaces/_internal_.Promise.html similarity index 100% rename from gh-pages/interfaces/_internal_.Promise.html rename to docs/interfaces/_internal_.Promise.html diff --git a/gh-pages/interfaces/_internal_.PromiseConstructor.html b/docs/interfaces/_internal_.PromiseConstructor.html similarity index 100% rename from gh-pages/interfaces/_internal_.PromiseConstructor.html rename to docs/interfaces/_internal_.PromiseConstructor.html diff --git a/gh-pages/interfaces/_internal_.PromiseFulfilledResult.html b/docs/interfaces/_internal_.PromiseFulfilledResult.html similarity index 100% rename from gh-pages/interfaces/_internal_.PromiseFulfilledResult.html rename to docs/interfaces/_internal_.PromiseFulfilledResult.html diff --git a/gh-pages/interfaces/_internal_.PromiseLike.html b/docs/interfaces/_internal_.PromiseLike.html similarity index 100% rename from gh-pages/interfaces/_internal_.PromiseLike.html rename to docs/interfaces/_internal_.PromiseLike.html diff --git a/gh-pages/interfaces/_internal_.PromiseRejectedResult.html b/docs/interfaces/_internal_.PromiseRejectedResult.html similarity index 100% rename from gh-pages/interfaces/_internal_.PromiseRejectedResult.html rename to docs/interfaces/_internal_.PromiseRejectedResult.html diff --git a/gh-pages/interfaces/_internal_.PropertyDescriptor.html b/docs/interfaces/_internal_.PropertyDescriptor.html similarity index 100% rename from gh-pages/interfaces/_internal_.PropertyDescriptor.html rename to docs/interfaces/_internal_.PropertyDescriptor.html diff --git a/gh-pages/interfaces/_internal_.PropertyDescriptorMap.html b/docs/interfaces/_internal_.PropertyDescriptorMap.html similarity index 100% rename from gh-pages/interfaces/_internal_.PropertyDescriptorMap.html rename to docs/interfaces/_internal_.PropertyDescriptorMap.html diff --git a/gh-pages/interfaces/_internal_.ProxyOpts.html b/docs/interfaces/_internal_.ProxyOpts.html similarity index 96% rename from gh-pages/interfaces/_internal_.ProxyOpts.html rename to docs/interfaces/_internal_.ProxyOpts.html index 7303ec1..a3d0da7 100644 --- a/gh-pages/interfaces/_internal_.ProxyOpts.html +++ b/docs/interfaces/_internal_.ProxyOpts.html @@ -1 +1 @@ -ProxyOpts | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ProxyOpts

Hierarchy

  • ProxyOpts

Index

Properties

Optional authentication

authentication?: { password: string; username: string }

Type declaration

  • password: string
  • username: string

host

host: string

port

port: number

Generated using TypeDoc

\ No newline at end of file +ProxyOpts | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ProxyOpts

Hierarchy

  • ProxyOpts

Index

Properties

Optional authentication

authentication?: { password: string; username: string }

Type declaration

  • password: string
  • username: string

host

host: string

port

port: number

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/interfaces/_internal_.ReadWriteStream.html b/docs/interfaces/_internal_.ReadWriteStream.html similarity index 100% rename from gh-pages/interfaces/_internal_.ReadWriteStream.html rename to docs/interfaces/_internal_.ReadWriteStream.html diff --git a/gh-pages/interfaces/_internal_.ReadableOptions.html b/docs/interfaces/_internal_.ReadableOptions.html similarity index 100% rename from gh-pages/interfaces/_internal_.ReadableOptions.html rename to docs/interfaces/_internal_.ReadableOptions.html diff --git a/gh-pages/interfaces/_internal_.ReadableStream.html b/docs/interfaces/_internal_.ReadableStream.html similarity index 100% rename from gh-pages/interfaces/_internal_.ReadableStream.html rename to docs/interfaces/_internal_.ReadableStream.html diff --git a/gh-pages/interfaces/_internal_.RefCounted.html b/docs/interfaces/_internal_.RefCounted.html similarity index 100% rename from gh-pages/interfaces/_internal_.RefCounted.html rename to docs/interfaces/_internal_.RefCounted.html diff --git a/gh-pages/interfaces/_internal_.RelativeIndexable.html b/docs/interfaces/_internal_.RelativeIndexable.html similarity index 100% rename from gh-pages/interfaces/_internal_.RelativeIndexable.html rename to docs/interfaces/_internal_.RelativeIndexable.html diff --git a/gh-pages/interfaces/_internal_.SearchOptions.html b/docs/interfaces/_internal_.SearchOptions.html similarity index 98% rename from gh-pages/interfaces/_internal_.SearchOptions.html rename to docs/interfaces/_internal_.SearchOptions.html index 2abc778..a990a2c 100644 --- a/gh-pages/interfaces/_internal_.SearchOptions.html +++ b/docs/interfaces/_internal_.SearchOptions.html @@ -1 +1 @@ -SearchOptions | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SearchOptions

Hierarchy

  • SearchOptions

Index

Properties

Properties

Optional limit

limit?: number

Optional source

source?: { deezer?: "playlist" | "track" | "album"; soundcloud?: "tracks" | "playlists" | "albums"; spotify?: "playlist" | "track" | "album"; youtube?: "video" | "playlist" | "channel" }

Type declaration

  • Optional deezer?: "playlist" | "track" | "album"
  • Optional soundcloud?: "tracks" | "playlists" | "albums"
  • Optional spotify?: "playlist" | "track" | "album"
  • Optional youtube?: "video" | "playlist" | "channel"

Generated using TypeDoc

\ No newline at end of file +SearchOptions | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SearchOptions

Hierarchy

  • SearchOptions

Index

Properties

Properties

Optional limit

limit?: number

Optional source

source?: { deezer?: "playlist" | "track" | "album"; soundcloud?: "tracks" | "playlists" | "albums"; spotify?: "playlist" | "track" | "album"; youtube?: "video" | "playlist" | "channel" }

Type declaration

  • Optional deezer?: "playlist" | "track" | "album"
  • Optional soundcloud?: "tracks" | "playlists" | "albums"
  • Optional spotify?: "playlist" | "track" | "album"
  • Optional youtube?: "video" | "playlist" | "channel"

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/interfaces/_internal_.SharedArrayBuffer.html b/docs/interfaces/_internal_.SharedArrayBuffer.html similarity index 100% rename from gh-pages/interfaces/_internal_.SharedArrayBuffer.html rename to docs/interfaces/_internal_.SharedArrayBuffer.html diff --git a/gh-pages/interfaces/_internal_.SharedArrayBufferConstructor.html b/docs/interfaces/_internal_.SharedArrayBufferConstructor.html similarity index 100% rename from gh-pages/interfaces/_internal_.SharedArrayBufferConstructor.html rename to docs/interfaces/_internal_.SharedArrayBufferConstructor.html diff --git a/gh-pages/interfaces/_internal_.SocketConstructorOpts.html b/docs/interfaces/_internal_.SocketConstructorOpts.html similarity index 100% rename from gh-pages/interfaces/_internal_.SocketConstructorOpts.html rename to docs/interfaces/_internal_.SocketConstructorOpts.html diff --git a/gh-pages/interfaces/_internal_.SoundCloudTrackDeprecated.html b/docs/interfaces/_internal_.SoundCloudTrackDeprecated.html similarity index 96% rename from gh-pages/interfaces/_internal_.SoundCloudTrackDeprecated.html rename to docs/interfaces/_internal_.SoundCloudTrackDeprecated.html index 5c41831..fddf885 100644 --- a/gh-pages/interfaces/_internal_.SoundCloudTrackDeprecated.html +++ b/docs/interfaces/_internal_.SoundCloudTrackDeprecated.html @@ -1 +1 @@ -SoundCloudTrackDeprecated | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SoundCloudTrackDeprecated

Hierarchy

  • SoundCloudTrackDeprecated

Index

Properties

Properties

fetched

fetched: boolean

id

id: number

type

type: "track"

Generated using TypeDoc

\ No newline at end of file +SoundCloudTrackDeprecated | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SoundCloudTrackDeprecated

Hierarchy

  • SoundCloudTrackDeprecated

Index

Properties

Properties

fetched

fetched: boolean

id

id: number

type

type: "track"

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/interfaces/_internal_.SoundCloudTrackFormat.html b/docs/interfaces/_internal_.SoundCloudTrackFormat.html similarity index 95% rename from gh-pages/interfaces/_internal_.SoundCloudTrackFormat.html rename to docs/interfaces/_internal_.SoundCloudTrackFormat.html index b550b54..11ee2df 100644 --- a/gh-pages/interfaces/_internal_.SoundCloudTrackFormat.html +++ b/docs/interfaces/_internal_.SoundCloudTrackFormat.html @@ -1 +1 @@ -SoundCloudTrackFormat | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SoundCloudTrackFormat

Hierarchy

  • SoundCloudTrackFormat

Index

Properties

duration

duration: number

format

format: { mime_type: string; protocol: string }

Type declaration

  • mime_type: string
  • protocol: string

preset

preset: string

quality

quality: string

url

url: string

Generated using TypeDoc

\ No newline at end of file +SoundCloudTrackFormat | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SoundCloudTrackFormat

Hierarchy

  • SoundCloudTrackFormat

Index

Properties

duration

duration: number

format

format: { mime_type: string; protocol: string }

Type declaration

  • mime_type: string
  • protocol: string

preset

preset: string

quality

quality: string

url

url: string

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/interfaces/_internal_.SoundCloudUser.html b/docs/interfaces/_internal_.SoundCloudUser.html similarity index 94% rename from gh-pages/interfaces/_internal_.SoundCloudUser.html rename to docs/interfaces/_internal_.SoundCloudUser.html index e2320f9..c1ac8a1 100644 --- a/gh-pages/interfaces/_internal_.SoundCloudUser.html +++ b/docs/interfaces/_internal_.SoundCloudUser.html @@ -1 +1 @@ -SoundCloudUser | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SoundCloudUser

Hierarchy

  • SoundCloudUser

Index

Properties

description

description: string

first_name

first_name: string

full_name

full_name: string

id

id: string

last_name

last_name: string

name

name: string

thumbnail

thumbnail: string

type

type: "playlist" | "track" | "user"

url

url: string

verified

verified: boolean

Generated using TypeDoc

\ No newline at end of file +SoundCloudUser | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SoundCloudUser

Hierarchy

  • SoundCloudUser

Index

Properties

description

description: string

first_name

first_name: string

full_name

full_name: string

id

id: string

last_name

last_name: string

name

name: string

thumbnail

thumbnail: string

type

type: "playlist" | "track" | "user"

url

url: string

verified

verified: boolean

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/interfaces/_internal_.SpotifyArtists.html b/docs/interfaces/_internal_.SpotifyArtists.html similarity index 96% rename from gh-pages/interfaces/_internal_.SpotifyArtists.html rename to docs/interfaces/_internal_.SpotifyArtists.html index 4c30d62..1bb5ff1 100644 --- a/gh-pages/interfaces/_internal_.SpotifyArtists.html +++ b/docs/interfaces/_internal_.SpotifyArtists.html @@ -1 +1 @@ -SpotifyArtists | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SpotifyArtists

Hierarchy

  • SpotifyArtists

Index

Properties

Properties

id

id: string

name

name: string

url

url: string

Generated using TypeDoc

\ No newline at end of file +SpotifyArtists | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SpotifyArtists

Hierarchy

  • SpotifyArtists

Index

Properties

Properties

id

id: string

name

name: string

url

url: string

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/interfaces/_internal_.SpotifyCopyright.html b/docs/interfaces/_internal_.SpotifyCopyright.html similarity index 97% rename from gh-pages/interfaces/_internal_.SpotifyCopyright.html rename to docs/interfaces/_internal_.SpotifyCopyright.html index e4091be..616a475 100644 --- a/gh-pages/interfaces/_internal_.SpotifyCopyright.html +++ b/docs/interfaces/_internal_.SpotifyCopyright.html @@ -1 +1 @@ -SpotifyCopyright | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SpotifyCopyright

Hierarchy

  • SpotifyCopyright

Index

Properties

Properties

text

text: string

type

type: string

Generated using TypeDoc

\ No newline at end of file +SpotifyCopyright | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SpotifyCopyright

Hierarchy

  • SpotifyCopyright

Index

Properties

Properties

text

text: string

type

type: string

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/interfaces/_internal_.SpotifyDataOptions.html b/docs/interfaces/_internal_.SpotifyDataOptions.html similarity index 93% rename from gh-pages/interfaces/_internal_.SpotifyDataOptions.html rename to docs/interfaces/_internal_.SpotifyDataOptions.html index 01e9312..ecc1c88 100644 --- a/gh-pages/interfaces/_internal_.SpotifyDataOptions.html +++ b/docs/interfaces/_internal_.SpotifyDataOptions.html @@ -1,3 +1,3 @@ SpotifyDataOptions | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SpotifyDataOptions

Spotify Data options that are stored in spotify.data file.

-

Hierarchy

  • SpotifyDataOptions

Index

Properties

Optional access_token

access_token?: string

Optional authorization_code

authorization_code?: string

client_id

client_id: string

client_secret

client_secret: string

Optional expires_in

expires_in?: number

Optional expiry

expiry?: number

Optional file

file?: boolean

Optional market

market?: string

Optional redirect_url

redirect_url?: string

Optional refresh_token

refresh_token?: string

Optional token_type

token_type?: string

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Optional access_token

access_token?: string

Optional authorization_code

authorization_code?: string

client_id

client_id: string

client_secret

client_secret: string

Optional expires_in

expires_in?: number

Optional expiry

expiry?: number

Optional file

file?: boolean

Optional market

market?: string

Optional redirect_url

redirect_url?: string

Optional refresh_token

refresh_token?: string

Optional token_type

token_type?: string

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/interfaces/_internal_.SpotifyThumbnail.html b/docs/interfaces/_internal_.SpotifyThumbnail.html similarity index 96% rename from gh-pages/interfaces/_internal_.SpotifyThumbnail.html rename to docs/interfaces/_internal_.SpotifyThumbnail.html index ce78f3a..0179ef5 100644 --- a/gh-pages/interfaces/_internal_.SpotifyThumbnail.html +++ b/docs/interfaces/_internal_.SpotifyThumbnail.html @@ -1 +1 @@ -SpotifyThumbnail | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SpotifyThumbnail

Hierarchy

  • SpotifyThumbnail

Index

Properties

Properties

height

height: number

url

url: string

width

width: number

Generated using TypeDoc

\ No newline at end of file +SpotifyThumbnail | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SpotifyThumbnail

Hierarchy

  • SpotifyThumbnail

Index

Properties

Properties

height

height: number

url

url: string

width

width: number

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/interfaces/_internal_.SpotifyTrackAlbum.html b/docs/interfaces/_internal_.SpotifyTrackAlbum.html similarity index 95% rename from gh-pages/interfaces/_internal_.SpotifyTrackAlbum.html rename to docs/interfaces/_internal_.SpotifyTrackAlbum.html index 8a655f0..1b0c462 100644 --- a/gh-pages/interfaces/_internal_.SpotifyTrackAlbum.html +++ b/docs/interfaces/_internal_.SpotifyTrackAlbum.html @@ -1 +1 @@ -SpotifyTrackAlbum | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SpotifyTrackAlbum

Hierarchy

  • SpotifyTrackAlbum

Index

Properties

id

id: string

name

name: string

release_date

release_date: string

release_date_precision

release_date_precision: string

total_tracks

total_tracks: number

url

url: string

Generated using TypeDoc

\ No newline at end of file +SpotifyTrackAlbum | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SpotifyTrackAlbum

Hierarchy

  • SpotifyTrackAlbum

Index

Properties

id

id: string

name

name: string

release_date

release_date: string

release_date_precision

release_date_precision: string

total_tracks

total_tracks: number

url

url: string

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/interfaces/_internal_.StaticEventEmitterOptions.html b/docs/interfaces/_internal_.StaticEventEmitterOptions.html similarity index 100% rename from gh-pages/interfaces/_internal_.StaticEventEmitterOptions.html rename to docs/interfaces/_internal_.StaticEventEmitterOptions.html diff --git a/gh-pages/interfaces/_internal_.StreamOptions-1.html b/docs/interfaces/_internal_.StreamOptions-1.html similarity index 100% rename from gh-pages/interfaces/_internal_.StreamOptions-1.html rename to docs/interfaces/_internal_.StreamOptions-1.html diff --git a/gh-pages/interfaces/_internal_.StreamOptions.html b/docs/interfaces/_internal_.StreamOptions.html similarity index 96% rename from gh-pages/interfaces/_internal_.StreamOptions.html rename to docs/interfaces/_internal_.StreamOptions.html index a12fe73..a210b26 100644 --- a/gh-pages/interfaces/_internal_.StreamOptions.html +++ b/docs/interfaces/_internal_.StreamOptions.html @@ -1 +1 @@ -StreamOptions | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StreamOptions

Hierarchy

  • StreamOptions

Index

Properties

Optional htmldata

htmldata?: boolean

Optional proxy

proxy?: ProxyOptions[]

Optional quality

quality?: number

Generated using TypeDoc

\ No newline at end of file +StreamOptions | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StreamOptions

Hierarchy

  • StreamOptions

Index

Properties

Optional htmldata

htmldata?: boolean

Optional proxy

proxy?: ProxyOptions[]

Optional quality

quality?: number

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/interfaces/_internal_.TcpSocketConnectOpts.html b/docs/interfaces/_internal_.TcpSocketConnectOpts.html similarity index 100% rename from gh-pages/interfaces/_internal_.TcpSocketConnectOpts.html rename to docs/interfaces/_internal_.TcpSocketConnectOpts.html diff --git a/gh-pages/interfaces/_internal_.ThisType.html b/docs/interfaces/_internal_.ThisType.html similarity index 100% rename from gh-pages/interfaces/_internal_.ThisType.html rename to docs/interfaces/_internal_.ThisType.html diff --git a/gh-pages/interfaces/_internal_.Timer-1.html b/docs/interfaces/_internal_.Timer-1.html similarity index 100% rename from gh-pages/interfaces/_internal_.Timer-1.html rename to docs/interfaces/_internal_.Timer-1.html diff --git a/gh-pages/interfaces/_internal_.TypedPropertyDescriptor.html b/docs/interfaces/_internal_.TypedPropertyDescriptor.html similarity index 100% rename from gh-pages/interfaces/_internal_.TypedPropertyDescriptor.html rename to docs/interfaces/_internal_.TypedPropertyDescriptor.html diff --git a/gh-pages/interfaces/_internal_.Uint16Array.html b/docs/interfaces/_internal_.Uint16Array.html similarity index 100% rename from gh-pages/interfaces/_internal_.Uint16Array.html rename to docs/interfaces/_internal_.Uint16Array.html diff --git a/gh-pages/interfaces/_internal_.Uint16ArrayConstructor.html b/docs/interfaces/_internal_.Uint16ArrayConstructor.html similarity index 100% rename from gh-pages/interfaces/_internal_.Uint16ArrayConstructor.html rename to docs/interfaces/_internal_.Uint16ArrayConstructor.html diff --git a/gh-pages/interfaces/_internal_.Uint32Array.html b/docs/interfaces/_internal_.Uint32Array.html similarity index 100% rename from gh-pages/interfaces/_internal_.Uint32Array.html rename to docs/interfaces/_internal_.Uint32Array.html diff --git a/gh-pages/interfaces/_internal_.Uint32ArrayConstructor.html b/docs/interfaces/_internal_.Uint32ArrayConstructor.html similarity index 100% rename from gh-pages/interfaces/_internal_.Uint32ArrayConstructor.html rename to docs/interfaces/_internal_.Uint32ArrayConstructor.html diff --git a/gh-pages/interfaces/_internal_.Uint8Array.html b/docs/interfaces/_internal_.Uint8Array.html similarity index 100% rename from gh-pages/interfaces/_internal_.Uint8Array.html rename to docs/interfaces/_internal_.Uint8Array.html diff --git a/gh-pages/interfaces/_internal_.Uint8ArrayConstructor.html b/docs/interfaces/_internal_.Uint8ArrayConstructor.html similarity index 100% rename from gh-pages/interfaces/_internal_.Uint8ArrayConstructor.html rename to docs/interfaces/_internal_.Uint8ArrayConstructor.html diff --git a/gh-pages/interfaces/_internal_.Uint8ClampedArray.html b/docs/interfaces/_internal_.Uint8ClampedArray.html similarity index 100% rename from gh-pages/interfaces/_internal_.Uint8ClampedArray.html rename to docs/interfaces/_internal_.Uint8ClampedArray.html diff --git a/gh-pages/interfaces/_internal_.Uint8ClampedArrayConstructor.html b/docs/interfaces/_internal_.Uint8ClampedArrayConstructor.html similarity index 100% rename from gh-pages/interfaces/_internal_.Uint8ClampedArrayConstructor.html rename to docs/interfaces/_internal_.Uint8ClampedArrayConstructor.html diff --git a/gh-pages/interfaces/_internal_.VideoOptions.html b/docs/interfaces/_internal_.VideoOptions.html similarity index 94% rename from gh-pages/interfaces/_internal_.VideoOptions.html rename to docs/interfaces/_internal_.VideoOptions.html index 6304c27..b3a9a79 100644 --- a/gh-pages/interfaces/_internal_.VideoOptions.html +++ b/docs/interfaces/_internal_.VideoOptions.html @@ -1 +1 @@ -VideoOptions | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface VideoOptions

Hierarchy

  • VideoOptions

Index

Properties

Optional channel

channel?: any

Optional description

description?: string

durationInSec

durationInSec: number

durationRaw

durationRaw: string

Optional id

id?: string

live

live: boolean

private

private: boolean

ratings

ratings: { dislikes: number; likes: number }

Type declaration

  • dislikes: number
  • likes: number

tags

tags: string[]

Optional thumbnail

thumbnail?: { height: undefined | number; id: undefined | string; url: undefined | string; width: undefined | number }

Type declaration

  • height: undefined | number
  • id: undefined | string
  • url: undefined | string
  • width: undefined | number

Optional title

title?: string

type

type: string

Optional uploadedAt

uploadedAt?: string

Optional url

url?: string

views

views: number

Generated using TypeDoc

\ No newline at end of file +VideoOptions | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface VideoOptions

Hierarchy

  • VideoOptions

Index

Properties

Optional channel

channel?: any

Optional description

description?: string

durationInSec

durationInSec: number

durationRaw

durationRaw: string

Optional id

id?: string

live

live: boolean

private

private: boolean

ratings

ratings: { dislikes: number; likes: number }

Type declaration

  • dislikes: number
  • likes: number

tags

tags: string[]

Optional thumbnail

thumbnail?: { height: undefined | number; id: undefined | string; url: undefined | string; width: undefined | number }

Type declaration

  • height: undefined | number
  • id: undefined | string
  • url: undefined | string
  • width: undefined | number

Optional title

title?: string

type

type: string

Optional uploadedAt

uploadedAt?: string

Optional url

url?: string

views

views: number

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/interfaces/_internal_.WritableStream.html b/docs/interfaces/_internal_.WritableStream.html similarity index 100% rename from gh-pages/interfaces/_internal_.WritableStream.html rename to docs/interfaces/_internal_.WritableStream.html diff --git a/gh-pages/interfaces/_internal_.internal.DuplexOptions.html b/docs/interfaces/_internal_.internal.DuplexOptions.html similarity index 100% rename from gh-pages/interfaces/_internal_.internal.DuplexOptions.html rename to docs/interfaces/_internal_.internal.DuplexOptions.html diff --git a/gh-pages/interfaces/_internal_.internal.FinishedOptions.html b/docs/interfaces/_internal_.internal.FinishedOptions.html similarity index 100% rename from gh-pages/interfaces/_internal_.internal.FinishedOptions.html rename to docs/interfaces/_internal_.internal.FinishedOptions.html diff --git a/gh-pages/interfaces/_internal_.internal.Pipe.html b/docs/interfaces/_internal_.internal.Pipe.html similarity index 100% rename from gh-pages/interfaces/_internal_.internal.Pipe.html rename to docs/interfaces/_internal_.internal.Pipe.html diff --git a/gh-pages/interfaces/_internal_.internal.PipelineOptions.html b/docs/interfaces/_internal_.internal.PipelineOptions.html similarity index 100% rename from gh-pages/interfaces/_internal_.internal.PipelineOptions.html rename to docs/interfaces/_internal_.internal.PipelineOptions.html diff --git a/gh-pages/interfaces/_internal_.internal.ReadableOptions.html b/docs/interfaces/_internal_.internal.ReadableOptions.html similarity index 100% rename from gh-pages/interfaces/_internal_.internal.ReadableOptions.html rename to docs/interfaces/_internal_.internal.ReadableOptions.html diff --git a/gh-pages/interfaces/_internal_.internal.StreamOptions.html b/docs/interfaces/_internal_.internal.StreamOptions.html similarity index 100% rename from gh-pages/interfaces/_internal_.internal.StreamOptions.html rename to docs/interfaces/_internal_.internal.StreamOptions.html diff --git a/gh-pages/interfaces/_internal_.internal.TransformOptions.html b/docs/interfaces/_internal_.internal.TransformOptions.html similarity index 100% rename from gh-pages/interfaces/_internal_.internal.TransformOptions.html rename to docs/interfaces/_internal_.internal.TransformOptions.html diff --git a/gh-pages/interfaces/_internal_.internal.WritableOptions.html b/docs/interfaces/_internal_.internal.WritableOptions.html similarity index 100% rename from gh-pages/interfaces/_internal_.internal.WritableOptions.html rename to docs/interfaces/_internal_.internal.WritableOptions.html diff --git a/gh-pages/interfaces/_internal_.tokenOptions.html b/docs/interfaces/_internal_.tokenOptions.html similarity index 96% rename from gh-pages/interfaces/_internal_.tokenOptions.html rename to docs/interfaces/_internal_.tokenOptions.html index 0c8c6de..59bfbf4 100644 --- a/gh-pages/interfaces/_internal_.tokenOptions.html +++ b/docs/interfaces/_internal_.tokenOptions.html @@ -1 +1 @@ -tokenOptions | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface tokenOptions

Hierarchy

  • tokenOptions

Index

Properties

Optional soundcloud

soundcloud?: { client_id: string }

Type declaration

  • client_id: string

Optional spotify

spotify?: { client_id: string; client_secret: string; market: string; refresh_token: string }

Type declaration

  • client_id: string
  • client_secret: string
  • market: string
  • refresh_token: string

Optional youtube

youtube?: { cookie: string }

Type declaration

  • cookie: string

Generated using TypeDoc

\ No newline at end of file +tokenOptions | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface tokenOptions

Hierarchy

  • tokenOptions

Index

Properties

Optional soundcloud

soundcloud?: { client_id: string }

Type declaration

  • client_id: string

Optional spotify

spotify?: { client_id: string; client_secret: string; market: string; refresh_token: string }

Type declaration

  • client_id: string
  • client_secret: string
  • market: string
  • refresh_token: string

Optional youtube

youtube?: { cookie: string }

Type declaration

  • cookie: string

Generated using TypeDoc

\ No newline at end of file diff --git a/gh-pages/modules.html b/docs/modules.html similarity index 97% rename from gh-pages/modules.html rename to docs/modules.html index 37289b1..c7a9802 100644 --- a/gh-pages/modules.html +++ b/docs/modules.html @@ -1,29 +1,29 @@ -play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

play-dl

Index

Type aliases

Deezer

+play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

play-dl

Index

Type aliases

Deezer

Shared type for Deezer tracks, playlists and albums

-

SoundCloud

+

SoundCloud

Type of SoundCloud

-

SoundCloudStream

SoundCloudStream: <internal>.Stream
+

SoundCloudStream

SoundCloudStream: <internal>.Stream

Type for SoundCloud Stream

-

Spotify

+

Spotify

type for Spotify Class

-

YouTube

+

YouTube

Type for YouTube returns

-

YouTubeStream

+

YouTubeStream

Type for YouTube Stream

-

Functions

attachListeners

authorization

  • authorization(): void

Functions

attachListeners

authorization

  • authorization(): void

cookieHeaders

  • cookieHeaders(headCookie: string[]): void

decipher_info

cookieHeaders

  • cookieHeaders(headCookie: string[]): void

decipher_info

deezer

deezer

dz_advanced_track_search

dz_advanced_track_search

Returns <internal>.Promise<DeezerTrack[]>

An array of tracks matching the metadata

-

dz_search

dz_search

  • Searches Deezer for tracks, playlists or albums

    Parameters

    • query: string

      The search query

      @@ -51,68 +51,68 @@ object depending on the provided URL.

    • fuzzy?: Whether the search should be fuzzy or only return exact matches. Defaults to true.

Returns <internal>.Promise<Deezer[]>

An array of tracks, playlists or albums

-

dz_validate

dz_validate

extractID

extractID

getFreeClientID

getFreeClientID

is_expired

is_expired

playlist_info

playlist_info

refreshToken

refreshToken

search

search

setToken

so_validate

setToken

so_validate

soundcloud

soundcloud

sp_validate

sp_validate

spotify

spotify

stream

stream

stream_from_info

stream_from_info

validate

validate

video_basic_info

video_basic_info

video_info

video_info

yt_validate

yt_validate