Files
YouTube.js/docs/api/namespaces/YTNodes/classes/CommentsEntryPointHeader.md
Luan 74659fd03f chore: add proper documentation (#763)
* chore: generate API ref using `typedoc`

* chore: declutter readme and add links to ytjs.dev

* chore: clean up
2024-09-23 17:32:50 -03:00

6.2 KiB

youtubei.js / YTNodes / CommentsEntryPointHeader

Class: CommentsEntryPointHeader

Extends

Constructors

new CommentsEntryPointHeader()

new CommentsEntryPointHeader(data): CommentsEntryPointHeader

Parameters

data: RawNode

Returns

CommentsEntryPointHeader

Overrides

YTNode.constructor

Defined in

src/parser/classes/comments/CommentsEntryPointHeader.ts:19

Properties

comment_count?

optional comment_count: Text

Defined in

src/parser/classes/comments/CommentsEntryPointHeader.ts:13


content_renderer?

optional content_renderer: null | CommentsSimplebox | CommentsEntryPointTeaser

Defined in

src/parser/classes/comments/CommentsEntryPointHeader.ts:16


header?

optional header: Text

Defined in

src/parser/classes/comments/CommentsEntryPointHeader.ts:12


simplebox_placeholder?

optional simplebox_placeholder: Text

Defined in

src/parser/classes/comments/CommentsEntryPointHeader.ts:17


teaser_avatar?

optional teaser_avatar: Thumbnail[]

Defined in

src/parser/classes/comments/CommentsEntryPointHeader.ts:14


teaser_content?

optional teaser_content: Text

Defined in

src/parser/classes/comments/CommentsEntryPointHeader.ts:15


type

readonly type: string

Inherited from

YTNode.type

Defined in

src/parser/helpers.ts:8


type

static type: string = 'CommentsEntryPointHeader'

Overrides

YTNode.type

Defined in

src/parser/classes/comments/CommentsEntryPointHeader.ts:10

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