youtubei.js / YTNodes / NavigationEndpoint

new NavigationEndpoint(data): NavigationEndpoint

Defined in: src/parser/classes/NavigationEndpoint.ts:32

Parameters

data

RawNode

Returns

NavigationEndpoint

Overrides

YTNode.constructor

Properties

command?

optional command: YTNode | YTNode & IEndpoint<any>

Defined in: src/parser/classes/NavigationEndpoint.ts:29

commands?

optional commands: NavigationEndpoint[]

Defined in: src/parser/classes/NavigationEndpoint.ts:30

dialog?

optional dialog: YTNode | CreatePlaylistDialog | null

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

metadata

metadata: Metadata

Defined in: src/parser/classes/NavigationEndpoint.ts:28

optional modal: YTNode | ModalWithTitleAndButton | null

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

name?

optional name: string

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

next_endpoint?

optional next_endpoint: NavigationEndpoint

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

optional open_popup: OpenPopupAction | null

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

payload

payload: any

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

type

readonly type: string

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

Inherited from

YTNode.type

type

static type: string = 'NavigationEndpoint'

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

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

call()

Call Signature

call<T>(actions, args): Promise<T>

Defined in: src/parser/classes/NavigationEndpoint.ts:121

Type Parameters

T

T extends IParsedResponse

Parameters

actions

Actions

args

parse

true

Returns

Promise<T>

Call Signature

call(actions, args?): Promise<ApiResponse>

Defined in: src/parser/classes/NavigationEndpoint.ts:122

Parameters

actions

Actions

args?

parse?

false

Returns

Promise<ApiResponse>

getPath()

getPath(name): "/browse" | "/player" | "/search" | "/next" | "/live_chat/get_item_context_menu" | undefined

Defined in: src/parser/classes/NavigationEndpoint.ts:105

Sometimes InnerTube does not return an API url, in that case the library should set it based on the name of the payload object.

Parameters

name

string

Returns

Deprecated

This should be removed in the future.

hasKey()

hasKey<T, R>(key): this is NavigationEndpoint & { [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 NavigationEndpoint & { [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

toURL()

toURL(): string | undefined

Defined in: src/parser/classes/NavigationEndpoint.ts:143

Returns

string | undefined