YouTube.js
Guide
Discord
GitHub
Guide
Discord
GitHub

youtubei.js / YTNodes / CompactVideo

Class: CompactVideo

Extends

  • YTNode

Constructors

new CompactVideo()

new CompactVideo(data): CompactVideo

Parameters

• data: RawNode

Returns

CompactVideo

Overrides

YTNode.constructor

Defined in

src/parser/classes/CompactVideo.ts:35

Properties

author

author: Author

Defined in

src/parser/classes/CompactVideo.ts:19


badges

badges: MetadataBadge[]

Defined in

src/parser/classes/CompactVideo.ts:25


endpoint?

optional endpoint: NavigationEndpoint

Defined in

src/parser/classes/CompactVideo.ts:27


is_watched

is_watched: boolean

Defined in

src/parser/classes/CompactVideo.ts:30


length_text?

optional length_text: Text

Defined in

src/parser/classes/CompactVideo.ts:29


long_byline_text?

optional long_byline_text: Text

Defined in

src/parser/classes/CompactVideo.ts:23


menu

menu: null | Menu

Defined in

src/parser/classes/CompactVideo.ts:28


published?

optional published: Text

Defined in

src/parser/classes/CompactVideo.ts:24


rich_thumbnail?

optional rich_thumbnail: YTNode

Defined in

src/parser/classes/CompactVideo.ts:17


service_endpoint?

optional service_endpoint: NavigationEndpoint

Defined in

src/parser/classes/CompactVideo.ts:32


service_endpoints?

optional service_endpoints: NavigationEndpoint[]

Defined in

src/parser/classes/CompactVideo.ts:31


short_byline_text?

optional short_byline_text: Text

Defined in

src/parser/classes/CompactVideo.ts:22


short_view_count?

optional short_view_count: Text

Defined in

src/parser/classes/CompactVideo.ts:21


style?

optional style: "COMPACT_VIDEO_STYLE_TYPE_UNKNOWN" | "COMPACT_VIDEO_STYLE_TYPE_NORMAL" | "COMPACT_VIDEO_STYLE_TYPE_PROMINENT_THUMBNAIL" | "COMPACT_VIDEO_STYLE_TYPE_HERO"

Defined in

src/parser/classes/CompactVideo.ts:33


thumbnail_overlays

thumbnail_overlays: ObservedArray<YTNode>

Defined in

src/parser/classes/CompactVideo.ts:26


thumbnails

thumbnails: Thumbnail[]

Defined in

src/parser/classes/CompactVideo.ts:16


title

title: Text

Defined in

src/parser/classes/CompactVideo.ts:18


type

readonly type: string

Inherited from

YTNode.type

Defined in

src/parser/helpers.ts:8


video_id

video_id: string

Defined in

src/parser/classes/CompactVideo.ts:15


view_count?

optional view_count: Text

Defined in

src/parser/classes/CompactVideo.ts:20


type

static type: string = 'CompactVideo'

Overrides

YTNode.type

Defined in

src/parser/classes/CompactVideo.ts:13

Accessors

best_thumbnail

get best_thumbnail(): Thumbnail

Returns

Thumbnail

Defined in

src/parser/classes/CompactVideo.ts:96


duration

get duration(): object

Returns

object

seconds

seconds: number

text

text: undefined | string = length_text

Defined in

src/parser/classes/CompactVideo.ts:87


id

get id(): string

Deprecated

Use video_id instead.

Returns

string

Defined in

src/parser/classes/CompactVideo.ts:83


is_fundraiser

get is_fundraiser(): boolean

Returns

boolean

Defined in

src/parser/classes/CompactVideo.ts:100


is_live

get is_live(): boolean

Returns

boolean

Defined in

src/parser/classes/CompactVideo.ts:104


is_new

get is_new(): boolean

Returns

boolean

Defined in

src/parser/classes/CompactVideo.ts:111


is_premiere

get is_premiere(): boolean

Returns

boolean

Defined in

src/parser/classes/CompactVideo.ts:115

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

YTNode.as

Defined in

src/parser/helpers.ts:29


hasKey()

hasKey<T, R>(key): this is CompactVideo & { [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 CompactVideo & { [k in string]: R }

Whether the node has the key

Inherited from

YTNode.hasKey

Defined in

src/parser/helpers.ts:41


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

YTNode.is

Defined in

src/parser/helpers.ts:19


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

Maybe

The value of the key wrapped in a Maybe

Throws

If the node does not have the key

Inherited from

YTNode.key

Defined in

src/parser/helpers.ts:51

Edit this page
Last Updated:: 6/8/25, 5:43 PM
Contributors: Luan