youtubei.js / YTNodes / CommentThread

Class: CommentThread

Defined in: src/parser/classes/comments/CommentThread.ts:15

Extends

YTNode

Constructors

Constructor

new CommentThread(data): CommentThread

Defined in: src/parser/classes/comments/CommentThread.ts:35

Parameters

data

Returns

CommentThread

Overrides

YTNode.constructor

Properties

comment

comment: CommentView | null

Defined in: src/parser/classes/comments/CommentThread.ts:18

comment_replies_data

comment_replies_data: CommentReplies | null

Defined in: src/parser/classes/comments/CommentThread.ts:20

has_replies

has_replies: boolean

Defined in: src/parser/classes/comments/CommentThread.ts:22

is_moderated_elq_comment

is_moderated_elq_comment: boolean

Defined in: src/parser/classes/comments/CommentThread.ts:21

rendering_priority?

optional rendering_priority?: "RENDERING_PRIORITY_UNKNOWN" | "RENDERING_PRIORITY_PINNED_COMMENT" | "RENDERING_PRIORITY_LINKED_COMMENT" | "RENDERING_PRIORITY_REALTIME_COMMENT" | "RENDERING_PRIORITY_COMMUNITY_GUIDELINES_BELOW_HEADER" | "RENDERING_PRIORITY_FAN_COMMUNITY_SETUP_CARD" | "RENDERING_PRIORITY_COMMENT_HEADER"

Defined in: src/parser/classes/comments/CommentThread.ts:23

replies?

optional replies?: ObservedArray<CommentThread>

Defined in: src/parser/classes/comments/CommentThread.ts:19

type

readonly type: string

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

Inherited from

YTNode.type

type

static type: string = 'CommentThread'

Defined in: src/parser/classes/comments/CommentThread.ts:16

Overrides

YTNode.type

Accessors

has_continuation

Get Signature

get has_continuation(): boolean

Defined in: src/parser/classes/comments/CommentThread.ts:47

Indicates whether this comment thread has more replies that can be fetched.

Returns

boolean

is_prepopulated

Get Signature

get is_prepopulated(): boolean

Defined in: src/parser/classes/comments/CommentThread.ts:56

Indicates whether this comment thread has prepopulated reply data. If false, you will need to call CommentThread.getReplies to fetch the initial batch of replies.

Returns

boolean

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

getContinuation()

getContinuation(): Promise<CommentsContinuation>

Defined in: src/parser/classes/comments/CommentThread.ts:99

Retrieves next batch of replies.

Returns

Promise<CommentsContinuation>

getReplies()

getReplies(): Promise<CommentThread>

Defined in: src/parser/classes/comments/CommentThread.ts:63

Retrieves replies to this comment thread.

Returns

Promise<CommentThread>

hasKey()

hasKey<T, R>(key): this is CommentThread & { [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 CommentThread & { [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

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

The value of the key wrapped in a Maybe

Throws

If the node does not have the key

Inherited from

processRepliesData()

processRepliesData(): void

Defined in: src/parser/classes/comments/CommentThread.ts:129

Internal

Returns

void

setActions()

setActions(actions): void

Defined in: src/parser/classes/comments/CommentThread.ts:122

Internal

Parameters

actions

Returns

void