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:33

Properties

author

author: Author

Defined in

src/parser/classes/CompactVideo.ts:18


badges

badges: MetadataBadge[]

Defined in

src/parser/classes/CompactVideo.ts:22


duration

duration: object

seconds

seconds: number

text

text: string

Defined in

src/parser/classes/CompactVideo.ts:24


endpoint

endpoint: NavigationEndpoint

Defined in

src/parser/classes/CompactVideo.ts:30


id

id: string

Defined in

src/parser/classes/CompactVideo.ts:14


menu

menu: null | Menu

Defined in

src/parser/classes/CompactVideo.ts:31


published

published: Text

Defined in

src/parser/classes/CompactVideo.ts:21


rich_thumbnail?

optional rich_thumbnail: YTNode

Defined in

src/parser/classes/CompactVideo.ts:16


short_view_count

short_view_count: Text

Defined in

src/parser/classes/CompactVideo.ts:20


thumbnail_overlays

thumbnail_overlays: ObservedArray<YTNode>

Defined in

src/parser/classes/CompactVideo.ts:29


thumbnails

thumbnails: Thumbnail[]

Defined in

src/parser/classes/CompactVideo.ts:15


title

title: Text

Defined in

src/parser/classes/CompactVideo.ts:17


type

readonly type: string

Inherited from

YTNode.type

Defined in

src/parser/helpers.ts:8


view_count

view_count: Text

Defined in

src/parser/classes/CompactVideo.ts:19


type

static type: string = 'CompactVideo'

Overrides

YTNode.type

Defined in

src/parser/classes/CompactVideo.ts:12

Accessors

best_thumbnail

get best_thumbnail(): Thumbnail

Returns

Thumbnail

Defined in

src/parser/classes/CompactVideo.ts:59


is_fundraiser

get is_fundraiser(): boolean

Returns

boolean

Defined in

src/parser/classes/CompactVideo.ts:63


is_live

get is_live(): boolean

Returns

boolean

Defined in

src/parser/classes/CompactVideo.ts:67


is_new

get is_new(): boolean

Returns

boolean

Defined in

src/parser/classes/CompactVideo.ts:74


is_premiere

get is_premiere(): boolean

Returns

boolean

Defined in

src/parser/classes/CompactVideo.ts:78

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:38


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:50


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:28


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:60

Edit this page
Last Updated:: 3/25/25, 8:08 PM
Contributors: EdamAme-x