youtubei.js / YTNodes / PlaylistHeader

new PlaylistHeader(data): PlaylistHeader

Defined in: src/parser/classes/PlaylistHeader.ts:27

Parameters

data

RawNode

Returns

PlaylistHeader

Overrides

YTNode.constructor

Properties

author

author: Author | null

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

banner: YTNode

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

brief_stats

brief_stats: Text[]

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

can_delete

can_delete: boolean

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

can_share: boolean

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

description

description: Text

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

id

id: string

Defined in: src/parser/classes/PlaylistHeader.ts:9

is_editable

is_editable: boolean

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

menu: YTNode

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

num_videos

num_videos: Text

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

privacy

privacy: string

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

save_button

save_button: YTNode

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

shuffle_play_button

shuffle_play_button: YTNode

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

stats

stats: Text[]

Defined in: src/parser/classes/PlaylistHeader.ts:12

subtitle

subtitle: Text | null

Defined in: src/parser/classes/PlaylistHeader.ts:11

title

title: Text

Defined in: src/parser/classes/PlaylistHeader.ts:10

type

readonly type: string

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

Inherited from

YTNode.type

view_count

view_count: Text

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

type

static type: string = 'PlaylistHeader'

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

Overrides

YTNode.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

YTNode.as

hasKey()

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

Whether the node has the key

Inherited from

YTNode.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

YTNode.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

YTNode.key