youtubei.js / YTNodes / TranscriptSegmentList
Class: TranscriptSegmentList
Defined in: src/parser/classes/TranscriptSegmentList.ts:9
Extends
Constructors
Constructor
new TranscriptSegmentList(
data
):TranscriptSegmentList
Defined in: src/parser/classes/TranscriptSegmentList.ts:17
Parameters
data
Returns
TranscriptSegmentList
Overrides
Properties
initial_segments
initial_segments:
ObservedArray
<TranscriptSectionHeader
|TranscriptSegment
>
Defined in: src/parser/classes/TranscriptSegmentList.ts:12
no_result_label
no_result_label:
Text
Defined in: src/parser/classes/TranscriptSegmentList.ts:13
retry_label
retry_label:
Text
Defined in: src/parser/classes/TranscriptSegmentList.ts:14
touch_captions_enabled
touch_captions_enabled:
boolean
Defined in: src/parser/classes/TranscriptSegmentList.ts:15
type
readonly
type:string
Defined in: src/parser/helpers.ts:8
Inherited from
type
static
type:string
='TranscriptSegmentList'
Defined in: src/parser/classes/TranscriptSegmentList.ts:10
Overrides
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
hasKey()
hasKey<
T
,R
>(key
):this is TranscriptSegmentList & { [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 TranscriptSegmentList & { [k in string]: R }
Whether the node has the key
Inherited from
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