youtubei.js / YTNodes / SubscribeEndpoint
Class: SubscribeEndpoint
Extends
Implements
Constructors
new SubscribeEndpoint()
new SubscribeEndpoint(
data):SubscribeEndpoint
Parameters
• data: RawNode
Returns
Overrides
Defined in
src/parser/classes/endpoints/SubscribeEndpoint.ts:10
Properties
type
readonlytype:string
Inherited from
Defined in
type
statictype:string='SubscribeEndpoint'
Overrides
Defined in
src/parser/classes/endpoints/SubscribeEndpoint.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
Defined in
buildRequest()
buildRequest():
SubscribeRequest
Returns
Implementation of
Defined in
src/parser/classes/endpoints/SubscribeEndpoint.ts:19
getApiPath()
getApiPath():
string
Returns
string
Implementation of
Defined in
src/parser/classes/endpoints/SubscribeEndpoint.ts:15
hasKey()
hasKey<
T,R>(key):this is SubscribeEndpoint & { [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 SubscribeEndpoint & { [k in string]: R }
Whether the node has the key
Inherited from
Defined in
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
Defined in
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
The value of the key wrapped in a Maybe
Throws
If the node does not have the key