YouTube.js/docs/api/namespaces/YTNodes/classes/VideoCard.md

youtubei.js / YTNodes / VideoCard

Class: VideoCard

Extends

• Video

Constructors

new VideoCard()

new VideoCard(data): VideoCard

Parameters

• data: RawNode

Returns

VideoCard

Overrides

Video.constructor

Defined in

src/parser/classes/VideoCard.ts:12

Properties

author

author: Author

Inherited from

Video.author

Defined in

src/parser/classes/Video.ts:27

---

badges

badges: MetadataBadge[]

Inherited from

Video.badges

Defined in

src/parser/classes/Video.ts:28

---

byline_text?

optional byline_text: Text

Overrides

Video.byline_text

Defined in

src/parser/classes/VideoCard.ts:10

---

description_snippet?

optional description_snippet: Text

Inherited from

Video.description_snippet

Defined in

src/parser/classes/Video.ts:18

---

duration

duration: object

seconds

seconds: number

text

text: string

Inherited from

Video.duration

Defined in

src/parser/classes/Video.ts:34

---

endpoint

endpoint: NavigationEndpoint

Inherited from

Video.endpoint

Defined in

src/parser/classes/Video.ts:29

---

expandable_metadata

expandable_metadata: null | ExpandableMetadata

Inherited from

Video.expandable_metadata

Defined in

src/parser/classes/Video.ts:23

---

id

id: string

Inherited from

Video.id

Defined in

src/parser/classes/Video.ts:16

---

is_watched

is_watched: boolean

Inherited from

Video.is_watched

Defined in

src/parser/classes/Video.ts:39

---

menu

menu: null | Menu

Inherited from

Video.menu

Defined in

src/parser/classes/Video.ts:40

---

metadata_text?

optional metadata_text: Text

Defined in

src/parser/classes/VideoCard.ts:9

---

published

published: Text

Inherited from

Video.published

Defined in

src/parser/classes/Video.ts:30

---

rich_thumbnail?

optional rich_thumbnail: YTNode

Inherited from

Video.rich_thumbnail

Defined in

src/parser/classes/Video.ts:26

---

search_video_result_entity_key?

optional search_video_result_entity_key: string

Inherited from

Video.search_video_result_entity_key

Defined in

src/parser/classes/Video.ts:42

---

short_view_count

short_view_count: Text

Inherited from

Video.short_view_count

Defined in

src/parser/classes/Video.ts:32

---

show_action_menu

show_action_menu: boolean

Inherited from

Video.show_action_menu

Defined in

src/parser/classes/Video.ts:38

---

snippets?

optional snippets: object[]

Inherited from

Video.snippets

Defined in

src/parser/classes/Video.ts:19

---

thumbnail_overlays

thumbnail_overlays: ObservedArray<YTNode>

Inherited from

Video.thumbnail_overlays

Defined in

src/parser/classes/Video.ts:25

---

thumbnails

thumbnails: Thumbnail[]

Inherited from

Video.thumbnails

Defined in

src/parser/classes/Video.ts:24

---

title

title: Text

Inherited from

Video.title

Defined in

src/parser/classes/Video.ts:17

---

type

readonly type: string

Inherited from

Video.type

Defined in

src/parser/helpers.ts:8

---

upcoming?

optional upcoming: Date

Inherited from

Video.upcoming

Defined in

src/parser/classes/Video.ts:33

---

view_count

view_count: Text

Inherited from

Video.view_count

Defined in

src/parser/classes/Video.ts:31

---

type

static type: string = 'VideoCard'

Overrides

Video.type

Defined in

src/parser/classes/VideoCard.ts:7

Accessors

best_thumbnail

get best_thumbnail(): undefined | Thumbnail

Returns

undefined | Thumbnail

Inherited from

Video.best_thumbnail

Defined in

src/parser/classes/Video.ts:132

---

description

get description(): string

Returns

string

Inherited from

Video.description

Defined in

src/parser/classes/Video.ts:101

---

has_captions

get has_captions(): boolean

Returns

boolean

Inherited from

Video.has_captions

Defined in

src/parser/classes/Video.ts:128

---

is_4k

get is_4k(): boolean

Returns

boolean

Inherited from

Video.is_4k

Defined in

src/parser/classes/Video.ts:124

---

is_live

get is_live(): boolean

Returns

boolean

Inherited from

Video.is_live

Defined in

src/parser/classes/Video.ts:109

---

is_premiere

get is_premiere(): boolean

Returns

boolean

Inherited from

Video.is_premiere

Defined in

src/parser/classes/Video.ts:120

---

is_upcoming

get is_upcoming(): undefined | boolean

Returns

undefined | boolean

Inherited from

Video.is_upcoming

Defined in

src/parser/classes/Video.ts:116

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

Video.as

Defined in

src/parser/helpers.ts:38

---

hasKey()

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

Whether the node has the key

Inherited from

Video.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

Video.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

Video.key

Defined in

src/parser/helpers.ts:60