mirror of
https://github.com/LuanRT/YouTube.js.git
synced 2026-06-16 19:12:24 +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.1 KiB
Markdown
35 lines
1.1 KiB
Markdown
## Comment
|
|
Contains information about a single comment. A [`Comment`](../../lib/parser/contents/classes/Comment.js) can be a top-level comment or a reply to a top-level comment.
|
|
|
|
## API
|
|
|
|
* Comment
|
|
* [.like](#like) ⇒ `function`
|
|
* [.dislike](#dislike) ⇒ `function`
|
|
* [.reply](#comment) ⇒ `function`
|
|
* [.translate](#translate) ⇒ `function`
|
|
|
|
<a name="like"></a>
|
|
### like()
|
|
Likes the comment.
|
|
|
|
**Returns:** `Promise.<{ success: boolean, status_code: number, data: object }>`
|
|
|
|
<a name="dislike"></a>
|
|
### dislike()
|
|
Dislikes the comment.
|
|
|
|
**Returns:** `Promise.<{ success: boolean, status_code: number, data: object }>`
|
|
|
|
<a name="reply"></a>
|
|
### reply(text)
|
|
Creates a reply to the comment. **Note:** To create a top-level comment, use the [`Comments#comment(text)`](./README.md#comment) method.
|
|
|
|
**Returns:** `Promise.<{ success: boolean, status_code: number, data: object }>`
|
|
|
|
<a name="translate"></a>
|
|
### translate(target_language)
|
|
Translates the comment to the given language.
|
|
|
|
**Returns:** `Promise.<{ success: boolean, status_code: number, data: object, content: string }>`
|