youtubei.js / YTNodes / SecondarySearchContainer
Class: SecondarySearchContainer
Extends
Constructors
new SecondarySearchContainer()
new SecondarySearchContainer(
data
):SecondarySearchContainer
Parameters
• data: RawNode
Returns
Overrides
Defined in
src/parser/classes/SecondarySearchContainer.ts:9
Properties
contents
contents:
ObservedArray
<YTNode
>
Defined in
src/parser/classes/SecondarySearchContainer.ts:7
type
readonly
type:string
Inherited from
Defined in
type
static
type:string
='SecondarySearchContainer'
Overrides
Defined in
src/parser/classes/SecondarySearchContainer.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
Returns
InstanceType
<K
[number
]>
Inherited from
Defined in
hasKey()
hasKey<
T
,R
>(key
):this is SecondarySearchContainer & { [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 SecondarySearchContainer & { [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