mirror of
https://github.com/LuanRT/YouTube.js.git
synced 2026-06-18 03:59:38 +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
47 lines
1.2 KiB
Markdown
47 lines
1.2 KiB
Markdown
## Comments
|
|
YouTube.js has full support for comments, including comment actions such as liking, disliking, replying etc.
|
|
|
|
## Usage
|
|
Get a [`Comments`](../../lib/parser/youtube/Comments.js) instance:
|
|
|
|
```js
|
|
const comments = await session.getComments(VIDEO_ID);
|
|
```
|
|
|
|
## API
|
|
* Comments
|
|
* [.contents](#commentthread) ⇒ `CommentThread[]`
|
|
* [.comment](#comment) ⇒ `function`
|
|
* [.getContinuation](#getc) ⇒ `function`
|
|
* [.page](#page) ⇒ `getter`
|
|
|
|
<a name="commentthread"></a>
|
|
### contents
|
|
A list of comment threads. **Note:** More about comment threads [**here**](./CommentThread.md).
|
|
|
|
**Type:** [`CommentThread[]`](../../lib/parser/contents/classes/CommentThread.js)
|
|
|
|
<a name="comment"></a>
|
|
### comment(text)
|
|
Posts a top-level comment.
|
|
|
|
| Param | Type | Description |
|
|
| --- | --- | --- |
|
|
| text | `string` | Comment content |
|
|
|
|
**Returns:** `Promise.<object>`
|
|
|
|
<a name="getc"></a>
|
|
### getContinuation()
|
|
Retrieves next batch of comment threads.
|
|
|
|
**Returns:** [`Promise.<Comments>`](../../lib/parser/youtube/Comments.js)
|
|
|
|
<a name="page"></a>
|
|
### page
|
|
Returns original InnerTube response (sanitized).
|
|
|
|
**Returns:** `Promise.<object>`
|
|
|
|
## Example
|
|
See [`index.js`]('./index.js'). |