youtubei.js / YTNodes / ShareEntityEndpoint

Class: ShareEntityEndpoint

Extends

ShareEntityServiceEndpoint

Constructors

new ShareEntityEndpoint()

new ShareEntityEndpoint(data): ShareEntityEndpoint

Parameters

• data: RawNode

Properties

type

readonly type: string

Inherited from

ShareEntityServiceEndpoint.type

Defined in

src/parser/helpers.ts:8

type

static type: string = 'ShareEntityEndpoint'

Overrides

ShareEntityServiceEndpoint.type

Defined in

src/parser/classes/endpoints/ShareEntityEndpoint.ts:5

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

ShareEntityServiceEndpoint.as

Defined in

src/parser/helpers.ts:38

buildRequest()

buildRequest(): ShareEntityServiceRequest

Returns

ShareEntityServiceRequest

Inherited from

ShareEntityServiceEndpoint.buildRequest

Defined in

src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts:19

getApiPath()

getApiPath(): string

Returns

string

Inherited from

ShareEntityServiceEndpoint.getApiPath

Defined in

src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts:15

hasKey()

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

Whether the node has the key

Inherited from

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

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

ShareEntityServiceEndpoint.key

Defined in

src/parser/helpers.ts:60