youtubei.js / YTNodes / CompactVideo

Class: CompactVideo

Defined in: src/parser/classes/CompactVideo.ts:12

Extends

• YTNode

Constructors

Constructor

new CompactVideo(data): CompactVideo

Defined in: src/parser/classes/CompactVideo.ts:35

Parameters

data

RawNode

Returns

CompactVideo

Overrides

YTNode.constructor

Properties

author

author: Author

Defined in: src/parser/classes/CompactVideo.ts:19

badges

badges: ObservedArray<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: Menu | null

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

Defined in: src/parser/helpers.ts:8

Inherited from

YTNode.type

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'

Defined in: src/parser/classes/CompactVideo.ts:13

Overrides

YTNode.type

Accessors

best_thumbnail

Get Signature

get best_thumbnail(): Thumbnail

Defined in: src/parser/classes/CompactVideo.ts:96

Returns

Thumbnail

duration

Get Signature

get duration(): object

Defined in: src/parser/classes/CompactVideo.ts:87

Returns

object

seconds

seconds: number

text

text: string | undefined = length_text

id

Get Signature

get id(): string

Defined in: src/parser/classes/CompactVideo.ts:83

Deprecated

Use video_id instead.

Returns

string

is_fundraiser

Get Signature

get is_fundraiser(): boolean

Defined in: src/parser/classes/CompactVideo.ts:100

Returns

boolean

is_live

Get Signature

get is_live(): boolean

Defined in: src/parser/classes/CompactVideo.ts:104

Returns

boolean

is_new

Get Signature

get is_new(): boolean

Defined in: src/parser/classes/CompactVideo.ts:111

Returns

boolean

is_premiere

Get Signature

get is_premiere(): boolean

Defined in: src/parser/classes/CompactVideo.ts:115

Returns

boolean

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

YTNode.as

hasKey()

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

Whether the node has the key

Inherited from

YTNode.hasKey

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

YTNode.is

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

Maybe

The value of the key wrapped in a Maybe

Throws

If the node does not have the key

Inherited from

YTNode.key