mirror of
https://github.com/LuanRT/YouTube.js.git
synced 2026-07-02 21:52:48 +00:00
chore(docs): update
This commit is contained in:
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: Post
|
||||
|
||||
Defined in: [src/parser/classes/Post.ts:4](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Post.ts#L4)
|
||||
Defined in: [src/parser/classes/Post.ts:4](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Post.ts#L4)
|
||||
|
||||
## Extends
|
||||
|
||||
@@ -14,7 +14,7 @@ Defined in: [src/parser/classes/Post.ts:4](https://github.com/LuanRT/YouTube.js/
|
||||
|
||||
> **new Post**(`data`): `Post`
|
||||
|
||||
Defined in: [src/parser/classes/Post.ts:7](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Post.ts#L7)
|
||||
Defined in: [src/parser/classes/Post.ts:7](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Post.ts#L7)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -36,7 +36,7 @@ Defined in: [src/parser/classes/Post.ts:7](https://github.com/LuanRT/YouTube.js/
|
||||
|
||||
> `optional` **action\_buttons**: [`CommentActionButtons`](CommentActionButtons.md) \| `null`
|
||||
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:21](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/BackstagePost.ts#L21)
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:21](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/BackstagePost.ts#L21)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -48,7 +48,7 @@ Defined in: [src/parser/classes/BackstagePost.ts:21](https://github.com/LuanRT/Y
|
||||
|
||||
> **attachment**: [`YTNode`](../../Helpers/classes/YTNode.md) \| `undefined`
|
||||
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:25](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/BackstagePost.ts#L25)
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:25](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/BackstagePost.ts#L25)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -60,7 +60,7 @@ Defined in: [src/parser/classes/BackstagePost.ts:25](https://github.com/LuanRT/Y
|
||||
|
||||
> **author**: [`Author`](../../Misc/classes/Author.md)
|
||||
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:14](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/BackstagePost.ts#L14)
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:14](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/BackstagePost.ts#L14)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -72,7 +72,7 @@ Defined in: [src/parser/classes/BackstagePost.ts:14](https://github.com/LuanRT/Y
|
||||
|
||||
> **content**: [`Text`](../../Misc/classes/Text.md)
|
||||
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:15](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/BackstagePost.ts#L15)
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:15](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/BackstagePost.ts#L15)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -84,7 +84,7 @@ Defined in: [src/parser/classes/BackstagePost.ts:15](https://github.com/LuanRT/Y
|
||||
|
||||
> `optional` **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md)
|
||||
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:24](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/BackstagePost.ts#L24)
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:24](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/BackstagePost.ts#L24)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -96,7 +96,7 @@ Defined in: [src/parser/classes/BackstagePost.ts:24](https://github.com/LuanRT/Y
|
||||
|
||||
> **id**: `string`
|
||||
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:13](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/BackstagePost.ts#L13)
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:13](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/BackstagePost.ts#L13)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -108,7 +108,7 @@ Defined in: [src/parser/classes/BackstagePost.ts:13](https://github.com/LuanRT/Y
|
||||
|
||||
> `optional` **menu**: [`Menu`](Menu.md) \| `null`
|
||||
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:20](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/BackstagePost.ts#L20)
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:20](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/BackstagePost.ts#L20)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -120,7 +120,7 @@ Defined in: [src/parser/classes/BackstagePost.ts:20](https://github.com/LuanRT/Y
|
||||
|
||||
> `optional` **poll\_status**: `string`
|
||||
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:17](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/BackstagePost.ts#L17)
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:17](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/BackstagePost.ts#L17)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -132,7 +132,7 @@ Defined in: [src/parser/classes/BackstagePost.ts:17](https://github.com/LuanRT/Y
|
||||
|
||||
> **published**: [`Text`](../../Misc/classes/Text.md)
|
||||
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:16](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/BackstagePost.ts#L16)
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:16](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/BackstagePost.ts#L16)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -144,7 +144,7 @@ Defined in: [src/parser/classes/BackstagePost.ts:16](https://github.com/LuanRT/Y
|
||||
|
||||
> **surface**: `string`
|
||||
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:23](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/BackstagePost.ts#L23)
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:23](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/BackstagePost.ts#L23)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -156,7 +156,7 @@ Defined in: [src/parser/classes/BackstagePost.ts:23](https://github.com/LuanRT/Y
|
||||
|
||||
> `readonly` **type**: `string`
|
||||
|
||||
Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L8)
|
||||
Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L8)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -168,7 +168,7 @@ Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> `optional` **vote\_button**: [`Button`](Button.md) \| `null`
|
||||
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:22](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/BackstagePost.ts#L22)
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:22](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/BackstagePost.ts#L22)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -180,7 +180,7 @@ Defined in: [src/parser/classes/BackstagePost.ts:22](https://github.com/LuanRT/Y
|
||||
|
||||
> `optional` **vote\_count**: [`Text`](../../Misc/classes/Text.md)
|
||||
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:19](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/BackstagePost.ts#L19)
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:19](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/BackstagePost.ts#L19)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -192,7 +192,7 @@ Defined in: [src/parser/classes/BackstagePost.ts:19](https://github.com/LuanRT/Y
|
||||
|
||||
> `optional` **vote\_status**: `string`
|
||||
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:18](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/BackstagePost.ts#L18)
|
||||
Defined in: [src/parser/classes/BackstagePost.ts:18](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/BackstagePost.ts#L18)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -204,7 +204,7 @@ Defined in: [src/parser/classes/BackstagePost.ts:18](https://github.com/LuanRT/Y
|
||||
|
||||
> `static` **type**: `string` = `'Post'`
|
||||
|
||||
Defined in: [src/parser/classes/Post.ts:5](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Post.ts#L5)
|
||||
Defined in: [src/parser/classes/Post.ts:5](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Post.ts#L5)
|
||||
|
||||
#### Overrides
|
||||
|
||||
@@ -216,7 +216,7 @@ Defined in: [src/parser/classes/Post.ts:5](https://github.com/LuanRT/YouTube.js/
|
||||
|
||||
> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\>
|
||||
|
||||
Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L29)
|
||||
Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L29)
|
||||
|
||||
Cast to one of the given types.
|
||||
|
||||
@@ -258,7 +258,7 @@ If the node is not of the given type
|
||||
|
||||
> **hasKey**\<`T`, `R`\>(`key`): `this is Post & { [k in string]: R }`
|
||||
|
||||
Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L41)
|
||||
Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L41)
|
||||
|
||||
Check for a key without asserting the type.
|
||||
|
||||
@@ -296,7 +296,7 @@ Whether the node has the key
|
||||
|
||||
> **is**\<`T`, `K`\>(...`types`): `this is InstanceType<K[number]>`
|
||||
|
||||
Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L19)
|
||||
Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L19)
|
||||
|
||||
Check if the node is of the given type.
|
||||
|
||||
@@ -334,7 +334,7 @@ whether the node is of the given type
|
||||
|
||||
> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md)
|
||||
|
||||
Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L51)
|
||||
Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L51)
|
||||
|
||||
Assert that the node has the given key and return it.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user