Files
YouTube.js/docs/api/namespaces/Helpers/classes/YTNode.md
2025-07-22 16:53:42 -03:00

40 KiB

youtubei.js / Helpers / YTNode

Class: YTNode

Extended by

Constructors

new YTNode()

new YTNode(): YTNode

Returns

YTNode

Defined in

src/parser/helpers.ts:10

Properties

type

readonly type: string

Defined in

src/parser/helpers.ts:8


type

readonly static type: string = 'YTNode'

Defined in

src/parser/helpers.ts:7

Methods

as()

as<T, K>(...types): InstanceType<K[number]>

Cast to one of the given types.

Type Parameters

T extends YTNode

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

Defined in

src/parser/helpers.ts:29


hasKey()

hasKey<T, R>(key): this is YTNode & { [k in string]: R }

Check for a key without asserting the type.

Type Parameters

T extends string

R = any

Parameters

key: T

The key to check

Returns

this is YTNode & { [k in string]: R }

Whether the node has the key

Defined in

src/parser/helpers.ts:41


is()

is<T, K>(...types): this is InstanceType<K[number]>

Check if the node is of the given type.

Type Parameters

T extends YTNode

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

Defined in

src/parser/helpers.ts:19


key()

key<T, R>(key): Maybe

Assert that the node has the given key and return it.

Type Parameters

T extends string

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

Defined in

src/parser/helpers.ts:51