youtubei.js / YTNodes / DescriptionPreviewView

new DescriptionPreviewView(data): DescriptionPreviewView

Defined in: src/parser/classes/DescriptionPreviewView.ts:26

Parameters

data

RawNode

Returns

DescriptionPreviewView

Overrides

YTNode.constructor

Properties

always_show_truncation_text

always_show_truncation_text: boolean

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

description?

optional description: Text

Defined in: src/parser/classes/DescriptionPreviewView.ts:10

max_lines?

optional max_lines: number

Defined in: src/parser/classes/DescriptionPreviewView.ts:11

more_endpoint?

optional more_endpoint: object

Defined in: src/parser/classes/DescriptionPreviewView.ts:14

show_engagement_panel_endpoint

show_engagement_panel_endpoint: object

show_engagement_panel_endpoint.engagement_panel

engagement_panel: EngagementPanelSectionList | null

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

renderer_context

renderer_context: RendererContext

Defined in: src/parser/classes/DescriptionPreviewView.ts:24

truncation_text?

optional truncation_text: Text

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

type

readonly type: string

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

Inherited from

YTNode.type

type

static type: string = 'DescriptionPreviewView'

Defined in: src/parser/classes/DescriptionPreviewView.ts:8

Overrides

YTNode.type

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