youtubei.js / YTNodes / CompactPlaylist

new CompactPlaylist(data): CompactPlaylist

Defined in: src/parser/classes/CompactPlaylist.ts:7

Parameters

data

RawNode

Returns

CompactPlaylist

Overrides

Playlist.constructor

Properties

author

author: Text | Author

Defined in: src/parser/classes/Playlist.ts:15

Inherited from

Playlist.author

badges

badges: ObservedArray<YTNode>

Defined in: src/parser/classes/Playlist.ts:23

Inherited from

Playlist.badges

endpoint

endpoint: NavigationEndpoint

Defined in: src/parser/classes/Playlist.ts:24

Inherited from

Playlist.endpoint

first_videos

first_videos: ObservedArray<YTNode>

Defined in: src/parser/classes/Playlist.ts:20

Inherited from

Playlist.first_videos

id

id: string

Defined in: src/parser/classes/Playlist.ts:13

Inherited from

Playlist.id

menu: YTNode

Defined in: src/parser/classes/Playlist.ts:22

Inherited from

Playlist.menu

share_url: string | null

Defined in: src/parser/classes/Playlist.ts:21

Inherited from

Playlist.share_url

thumbnail_overlays

thumbnail_overlays: ObservedArray<YTNode>

Defined in: src/parser/classes/Playlist.ts:25

Inherited from

Playlist.thumbnail_overlays

thumbnail_renderer?

optional thumbnail_renderer: PlaylistCustomThumbnail | PlaylistVideoThumbnail

Defined in: src/parser/classes/Playlist.ts:17

Inherited from

Playlist.thumbnail_renderer

thumbnails

thumbnails: Thumbnail[]

Defined in: src/parser/classes/Playlist.ts:16

Inherited from

Playlist.thumbnails

title

title: Text

Defined in: src/parser/classes/Playlist.ts:14

Inherited from

Playlist.title

type

readonly type: string

Defined in: src/parser/helpers.ts:8

Inherited from

Playlist.type

video_count

video_count: Text

Defined in: src/parser/classes/Playlist.ts:18

Inherited from

Playlist.video_count

video_count_short

video_count_short: Text

Defined in: src/parser/classes/Playlist.ts:19

Inherited from

Playlist.video_count_short

view_playlist?

optional view_playlist: Text

Defined in: src/parser/classes/Playlist.ts:26

Inherited from

Playlist.view_playlist

type

static type: string = 'CompactPlaylist'

Defined in: src/parser/classes/CompactPlaylist.ts:5

Overrides

Playlist.type

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

Playlist.as

hasKey()

hasKey<T, R>(key): this is CompactPlaylist & { [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 CompactPlaylist & { [k in string]: R }

Whether the node has the key

Inherited from

Playlist.hasKey

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

Playlist.is

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

Maybe

The value of the key wrapped in a Maybe

Throws

If the node does not have the key

Inherited from

Playlist.key