Files
YouTube.js/docs/api/namespaces/YT/classes/Comments.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

3.0 KiB

youtubei.js / YT / Comments

Class: Comments

Constructors

new Comments()

new Comments(actions, data, already_parsed): Comments

Parameters

actions: Actions

data: any

already_parsed: boolean = false

Returns

Comments

Defined in

src/parser/youtube/Comments.ts:22

Properties

contents

contents: ObservedArray<CommentThread>

Defined in

src/parser/youtube/Comments.ts:20


header?

optional header: CommentsHeader

Defined in

src/parser/youtube/Comments.ts:19

Accessors

has_continuation

get has_continuation(): boolean

Returns

boolean

Defined in

src/parser/youtube/Comments.ts:117


page

get page(): INextResponse

Returns

INextResponse

Defined in

src/parser/youtube/Comments.ts:121

Methods

applySort()

applySort(sort): Promise<Comments>

Applies given sort option to the comments.

Parameters

sort: "TOP_COMMENTS" | "NEWEST_FIRST"

Sort type.

Returns

Promise<Comments>

Defined in

src/parser/youtube/Comments.ts:51


createComment()

createComment(text): Promise<ApiResponse>

Creates a top-level comment.

Parameters

text: string

Comment text.

Returns

Promise<ApiResponse>

Defined in

src/parser/youtube/Comments.ts:78


getContinuation()

getContinuation(): Promise<Comments>

Retrieves next batch of comments.

Returns

Promise<Comments>

Defined in

src/parser/youtube/Comments.ts:98