youtubei.js / YTNodes / Playlist
Class: Playlist
Defined in: src/parser/classes/Playlist.ts:10
Extends
Extended by
Constructors
Constructor
new Playlist(
data
):Playlist
Defined in: src/parser/classes/Playlist.ts:28
Parameters
data
Returns
Playlist
Overrides
Properties
author
Defined in: src/parser/classes/Playlist.ts:15
badges
badges:
ObservedArray
<YTNode
>
Defined in: src/parser/classes/Playlist.ts:23
endpoint
endpoint:
NavigationEndpoint
Defined in: src/parser/classes/Playlist.ts:24
first_videos
first_videos:
ObservedArray
<YTNode
>
Defined in: src/parser/classes/Playlist.ts:20
id
id:
string
Defined in: src/parser/classes/Playlist.ts:13
menu
menu:
YTNode
Defined in: src/parser/classes/Playlist.ts:22
share_url
share_url:
string
|null
Defined in: src/parser/classes/Playlist.ts:21
thumbnail_overlays
thumbnail_overlays:
ObservedArray
<YTNode
>
Defined in: src/parser/classes/Playlist.ts:25
thumbnail_renderer?
optional
thumbnail_renderer:PlaylistCustomThumbnail
|PlaylistVideoThumbnail
Defined in: src/parser/classes/Playlist.ts:17
thumbnails
thumbnails:
Thumbnail
[]
Defined in: src/parser/classes/Playlist.ts:16
title
title:
Text
Defined in: src/parser/classes/Playlist.ts:14
type
readonly
type:string
Defined in: src/parser/helpers.ts:8
Inherited from
video_count
video_count:
Text
Defined in: src/parser/classes/Playlist.ts:18
video_count_short
video_count_short:
Text
Defined in: src/parser/classes/Playlist.ts:19
view_playlist?
optional
view_playlist:Text
Defined in: src/parser/classes/Playlist.ts:26
type
static
type:string
='Playlist'
Defined in: src/parser/classes/Playlist.ts:11
Overrides
Methods
as()
as<
T
,K
>(...types
):InstanceType
<K
[number
]>
Defined in: src/parser/helpers.ts:29
Cast to one of the given types.
Type Parameters
T
T
extends YTNode
K
K
extends YTNodeConstructor
<T
>[]
Parameters
types
...K
The types to cast to
Returns
InstanceType
<K
[number
]>
The node cast to one of the given types
Throws
If the node is not of the given type
Inherited from
hasKey()
hasKey<
T
,R
>(key
):this is Playlist & { [k in string]: R }
Defined in: src/parser/helpers.ts:41
Check for a key without asserting the type.
Type Parameters
T
T
extends string
R
R
= any
Parameters
key
T
The key to check
Returns
this is Playlist & { [k in string]: R }
Whether the node has the key
Inherited from
is()
is<
T
,K
>(...types
):this is InstanceType<K[number]>
Defined in: src/parser/helpers.ts:19
Check if the node is of the given type.
Type Parameters
T
T
extends YTNode
K
K
extends YTNodeConstructor
<T
>[]
Parameters
types
...K
The type to check
Returns
this is InstanceType<K[number]>
whether the node is of the given type
Inherited from
key()
key<
T
,R
>(key
):Maybe
Defined in: src/parser/helpers.ts:51
Assert that the node has the given key and return it.
Type Parameters
T
T
extends string
R
R
= any
Parameters
key
T
The key to check
Returns
The value of the key wrapped in a Maybe
Throws
If the node does not have the key