youtubei.js / YTNodes / ShareEntityEndpoint
Class: ShareEntityEndpoint
Defined in: src/parser/classes/endpoints/ShareEntityEndpoint.ts:4
Extends
Constructors
Constructor
new ShareEntityEndpoint(
data):ShareEntityEndpoint
Defined in: src/parser/classes/endpoints/ShareEntityEndpoint.ts:7
Parameters
data
Returns
ShareEntityEndpoint
Overrides
ShareEntityServiceEndpoint.constructor
Properties
type
readonlytype:string
Defined in: src/parser/helpers.ts:8
Inherited from
ShareEntityServiceEndpoint.type
type
statictype:string='ShareEntityEndpoint'
Defined in: src/parser/classes/endpoints/ShareEntityEndpoint.ts:5
Overrides
ShareEntityServiceEndpoint.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
buildRequest()
buildRequest():
ShareEntityServiceRequest
Defined in: src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts:20
Returns
Inherited from
ShareEntityServiceEndpoint.buildRequest
getApiPath()
getApiPath():
string
Defined in: src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts:16
Returns
string
Inherited from
ShareEntityServiceEndpoint.getApiPath
hasKey()
hasKey<
T,R>(key):this is ShareEntityEndpoint & { [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 ShareEntityEndpoint & { [k in string]: R }
Whether the node has the key
Inherited from
ShareEntityServiceEndpoint.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
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
The value of the key wrapped in a Maybe
Throws
If the node does not have the key