youtubei.js / YTNodes / DescriptionPreviewView

Class: DescriptionPreviewView

Extends

YTNode

Constructors

new DescriptionPreviewView()

new DescriptionPreviewView(data): DescriptionPreviewView

Parameters

• data: RawNode

Properties

always_show_truncation_text

always_show_truncation_text: boolean

Defined in

src/parser/classes/DescriptionPreviewView.ts:12

description

description: Text

Defined in

src/parser/classes/DescriptionPreviewView.ts:9

max_lines

max_lines: number

Defined in

src/parser/classes/DescriptionPreviewView.ts:10

more_endpoint?

optional more_endpoint: object

show_engagement_panel_endpoint

show_engagement_panel_endpoint: object

show_engagement_panel_endpoint.engagement_panel

engagement_panel: null | EngagementPanelSectionList

engagement_panel_popup_type: string

show_engagement_panel_endpoint.identifier

identifier: object

show_engagement_panel_endpoint.identifier.surface

surface: string

show_engagement_panel_endpoint.identifier.tag

tag: string

Defined in

src/parser/classes/DescriptionPreviewView.ts:13

truncation_text

truncation_text: Text

Defined in

src/parser/classes/DescriptionPreviewView.ts:11

type

readonly type: string

Inherited from

YTNode.type

Defined in

src/parser/helpers.ts:8

type

static type: string = 'DescriptionPreviewView'

Overrides

YTNode.type

Defined in

src/parser/classes/DescriptionPreviewView.ts:7

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

Returns

InstanceType<K[number]>

Inherited from

YTNode.as

Defined in

src/parser/helpers.ts:35

hasKey()

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

Whether the node has the key

Inherited from

YTNode.hasKey

Defined in

src/parser/helpers.ts:47

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