mirror of
https://github.com/LuanRT/YouTube.js.git
synced 2026-06-13 09:32:12 +00:00
1d62e469a9
* feat: add core comments section classes * chore: update type declarations * chore: fix linter warnings * style: fix linter * chore: update tests * chore(tests): fix typo * chore(tests): fix typo x2 * fix(tests): `getReplies()` method is only present in `CommentThread` and not `Comment` * chore(tests): fix comment id path * chore(tests): remove outdated code * chore(tests): fix results path * chore: enforce code style * chore: update type declarations * docs: add examples and documentation * chore(docs): fix paths * chore(docs): fix more paths * chore(docs): fix `Comments.js` path * chore(docs): fix typo * chore(docs): mention example file * chore(examples): fix imports * chore(examples): fix typo
35 lines
1.2 KiB
Markdown
35 lines
1.2 KiB
Markdown
# CommentThread
|
|
|
|
A `CommentThread` represents a top-level comment and its replies.
|
|
|
|
## API
|
|
|
|
* CommentThread
|
|
* [.comment](#comment) ⇒ `Comment`
|
|
* [.replies](#replies) ⇒ `Comment[]`
|
|
* [.getReplies](#getreplies) ⇒ `function`
|
|
* [.getContinuation](#getcontinuation) ⇒ `function`
|
|
|
|
<a name="comment"></a>
|
|
### comment
|
|
The top-level comment. **Note:** More about `Comment` [here](./Comment.md).
|
|
|
|
**Type:** [`Comment`](../../lib/parser/contents/classes/Comment.js)
|
|
|
|
<a name="replies"></a>
|
|
### replies
|
|
An array of replies to the top-level comment. (not populated until [`getReplies()`](#getreplies) is called).
|
|
|
|
**Type:** [`Comment[]`](../../lib/parser/contents/classes/Comment.js)
|
|
|
|
<a name="getreplies"></a>
|
|
### getReplies()
|
|
Retrieves replies to the top-level comment and attaches a [`replies`](#replies) array to the original `CommentThread` object and returns it.
|
|
|
|
**Returns:** [`Promise.<CommentThread>`](../../lib/parser/contents/classes/CommentThread.js)
|
|
|
|
<a name="getcontinuation"></a>
|
|
### getContinuation()
|
|
Retrieves next batch of replies and adds them to the [`replies`](#replies) array. **Note:** [`getReplies()`](#getreplies) must be called before using this.
|
|
|
|
**Returns:** [`Promise.<CommentThread>`](../../lib/parser/contents/classes/CommentThread.js) |