youtubei.js / YTNodes / Video
Class: Video
Extends
Extended by
Constructors
new Video()
new Video(
data
):Video
Parameters
• data: RawNode
Returns
Overrides
Defined in
src/parser/classes/Video.ts:43
Properties
author
author:
Author
Defined in
src/parser/classes/Video.ts:27
badges
badges:
MetadataBadge
[]
Defined in
src/parser/classes/Video.ts:28
description_snippet?
optional
description_snippet:Text
Defined in
src/parser/classes/Video.ts:18
duration
duration:
object
seconds
seconds:
number
text
text:
string
Defined in
src/parser/classes/Video.ts:34
endpoint
endpoint:
NavigationEndpoint
Defined in
src/parser/classes/Video.ts:29
expandable_metadata
expandable_metadata:
null
|ExpandableMetadata
Defined in
src/parser/classes/Video.ts:23
id
id:
string
Defined in
src/parser/classes/Video.ts:16
is_watched
is_watched:
boolean
Defined in
src/parser/classes/Video.ts:39
menu
menu:
null
|Menu
Defined in
src/parser/classes/Video.ts:40
published
published:
Text
Defined in
src/parser/classes/Video.ts:30
rich_thumbnail?
optional
rich_thumbnail:YTNode
Defined in
src/parser/classes/Video.ts:26
search_video_result_entity_key?
optional
search_video_result_entity_key:string
Defined in
src/parser/classes/Video.ts:41
short_view_count
short_view_count:
Text
Defined in
src/parser/classes/Video.ts:32
show_action_menu
show_action_menu:
boolean
Defined in
src/parser/classes/Video.ts:38
snippets?
optional
snippets:object
[]
Defined in
src/parser/classes/Video.ts:19
thumbnail_overlays
thumbnail_overlays:
ObservedArray
<YTNode
>
Defined in
src/parser/classes/Video.ts:25
thumbnails
thumbnails:
Thumbnail
[]
Defined in
src/parser/classes/Video.ts:24
title
title:
Text
Defined in
src/parser/classes/Video.ts:17
type
readonly
type:string
Inherited from
Defined in
upcoming?
optional
upcoming:Date
Defined in
src/parser/classes/Video.ts:33
view_count
view_count:
Text
Defined in
src/parser/classes/Video.ts:31
type
static
type:string
='Video'
Overrides
Defined in
src/parser/classes/Video.ts:14
Accessors
best_thumbnail
get
best_thumbnail():undefined
|Thumbnail
Returns
undefined
| Thumbnail
Defined in
src/parser/classes/Video.ts:127
description
get
description():string
Returns
string
Defined in
src/parser/classes/Video.ts:96
has_captions
get
has_captions():boolean
Returns
boolean
Defined in
src/parser/classes/Video.ts:123
is_4k
get
is_4k():boolean
Returns
boolean
Defined in
src/parser/classes/Video.ts:119
is_live
get
is_live():boolean
Returns
boolean
Defined in
src/parser/classes/Video.ts:104
is_premiere
get
is_premiere():boolean
Returns
boolean
Defined in
src/parser/classes/Video.ts:115
is_upcoming
get
is_upcoming():undefined
|boolean
Returns
undefined
| boolean
Defined in
src/parser/classes/Video.ts:111
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
hasKey()
hasKey<
T
,R
>(key
):this is Video & { [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 Video & { [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