youtubei.js / YTNodes / CompactMovie

Class: CompactMovie

Extends

YTNode

Constructors

new CompactMovie()

new CompactMovie(data): CompactMovie

Parameters

• data: RawNode

Properties

author

author: Author

Defined in

src/parser/classes/CompactMovie.ts:19

badges

badges: ObservedArray<YTNode>

Defined in

src/parser/classes/CompactMovie.ts:27

duration

duration: object

seconds

seconds: number

text

text: string

Defined in

src/parser/classes/CompactMovie.ts:21

endpoint

endpoint: NavigationEndpoint

Defined in

src/parser/classes/CompactMovie.ts:26

id

id: string

Defined in

src/parser/classes/CompactMovie.ts:14

menu: null | Menu

Defined in

src/parser/classes/CompactMovie.ts:29

thumbnail_overlays

thumbnail_overlays: ObservedArray<YTNode>

Defined in

src/parser/classes/CompactMovie.ts:18

thumbnails

thumbnails: Thumbnail[]

Defined in

src/parser/classes/CompactMovie.ts:17

title

title: Text

Defined in

src/parser/classes/CompactMovie.ts:15

top_metadata_items

top_metadata_items: Text

Defined in

src/parser/classes/CompactMovie.ts:16

type

readonly type: string

Inherited from

YTNode.type

Defined in

src/parser/helpers.ts:8

use_vertical_poster

use_vertical_poster: boolean

Defined in

src/parser/classes/CompactMovie.ts:28

type

static type: string = 'CompactMovie'

Overrides

YTNode.type

Defined in

src/parser/classes/CompactMovie.ts:12

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 CompactMovie & { [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 CompactMovie & { [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