diff --git a/examples/comments/README.md b/examples/comments/README.md index fd4e786d..ab3e4163 100644 --- a/examples/comments/README.md +++ b/examples/comments/README.md @@ -11,7 +11,7 @@ const comments = await session.getComments(VIDEO_ID); ## API * Comments * [.contents](#commentthread) ⇒ `CommentThread[]` - * [.comment](#comment) ⇒ `function` + * [.createComment](#createComment) ⇒ `function` * [.getContinuation](#getc) ⇒ `function` * [.page](#page) ⇒ `getter` @@ -21,27 +21,27 @@ A list of comment threads. **Note:** More about comment threads [**here**](./Com **Type:** [`CommentThread[]`](../../lib/parser/contents/classes/CommentThread.js) - -### comment(text) -Posts a top-level comment. + +### createComment(text) +Creates a top-level comment. | Param | Type | Description | | --- | --- | --- | | text | `string` | Comment content | -**Returns:** `Promise.` +**Returns:** `Promise` ### getContinuation() Retrieves next batch of comment threads. -**Returns:** [`Promise.`](../../lib/parser/youtube/Comments.js) +**Returns:** [`Promise.`](../../lib/parser/youtube/Comments.ts) ### page Returns original InnerTube response (sanitized). -**Returns:** `Promise.` +**Returns:** `ParsedResponse` ## Example See [`index.ts`]('./index.ts'). \ No newline at end of file