Histmy/play-dl-fix
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve documentation for playlist_info (fixes #247)

Browse Source
This commit is contained in:
absidue 2022-01-31 18:00:45 +01:00
parent 62711f87b8
commit de6d8eae75
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
play-dl/YouTube/utils/extractor.ts
View File

@ -461,7 +461,10 @@ export async function decipher_info<T extends InfoData | StreamInfoData>(
* ``` * ```
* @param url Playlist URL * @param url Playlist URL
* @param options Playlist Info Options * @param options Playlist Info Options
* - `boolean` incomplete : If set to true, parses playlist with hidden videos. * - `boolean` incomplete : When this is set to `false` (default) this function will throw an error
* if the playlist contains hidden videos.
* If it is set to `true`, it parses the playlist skipping the hidden videos,
* only visible videos are included in the resulting {@link YouTubePlaylist}.
* *
* @returns YouTube Playlist * @returns YouTube Playlist
*/ */