YouTube.js/docs/api/namespaces/YTNodes/classes/NavigationEndpoint.md

youtubei.js / YTNodes / NavigationEndpoint

Class: NavigationEndpoint

Extends

• YTNode

Constructors

new NavigationEndpoint()

new NavigationEndpoint(data): NavigationEndpoint

Parameters

• data: RawNode

Returns

NavigationEndpoint

Overrides

YTNode.constructor

Defined in

src/parser/classes/NavigationEndpoint.ts:31

Properties

command?

optional command: YTNode | YTNode & IEndpoint<any>

Defined in

src/parser/classes/NavigationEndpoint.ts:28

---

commands?

optional commands: NavigationEndpoint[]

Defined in

src/parser/classes/NavigationEndpoint.ts:29

---

dialog?

optional dialog: null | YTNode | CreatePlaylistDialog

Defined in

src/parser/classes/NavigationEndpoint.ts:23

---

metadata

metadata: Metadata

Defined in

src/parser/classes/NavigationEndpoint.ts:27

---

modal?

optional modal: null | YTNode | ModalWithTitleAndButton

Defined in

src/parser/classes/NavigationEndpoint.ts:24

---

name?

optional name: string

Defined in

src/parser/classes/NavigationEndpoint.ts:21

---

next_endpoint?

optional next_endpoint: NavigationEndpoint

Defined in

src/parser/classes/NavigationEndpoint.ts:26

---

open_popup?

optional open_popup: null | OpenPopupAction

Defined in

src/parser/classes/NavigationEndpoint.ts:25

---

payload

payload: any

Defined in

src/parser/classes/NavigationEndpoint.ts:22

---

type

readonly type: string

Inherited from

YTNode.type

Defined in

src/parser/helpers.ts:8

---

type

static type: string = 'NavigationEndpoint'

Overrides

YTNode.type

Defined in

src/parser/classes/NavigationEndpoint.ts:19

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

Inherited from

YTNode.as

Defined in

src/parser/helpers.ts:38

---

call()

call(actions, args)

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

Type Parameters

• T extends IParsedResponse

Parameters

• actions: Actions

• args

• args.parse: true

Returns

Promise<T>

Defined in

src/parser/classes/NavigationEndpoint.ts:120

call(actions, args)

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

Parameters

• actions: Actions

• args?

• args.parse?: false

Returns

Promise<ApiResponse>

Defined in

src/parser/classes/NavigationEndpoint.ts:121

---

getPath()

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

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

undefined | "/player" | "/search" | "/browse" | "/next" | "/live_chat/get_item_context_menu"

Deprecated

This should be removed in the future.

Defined in

src/parser/classes/NavigationEndpoint.ts:104

---

hasKey()

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

Whether the node has the key

Inherited from

YTNode.hasKey

Defined in

src/parser/helpers.ts:50

---

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

Inherited from

YTNode.is

Defined in

src/parser/helpers.ts:28

---

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

Inherited from

YTNode.key

Defined in

src/parser/helpers.ts:60

---

toURL()

toURL(): undefined | string

Returns

undefined | string

Defined in

src/parser/classes/NavigationEndpoint.ts:137