mirror of
https://github.com/LuanRT/YouTube.js.git
synced 2026-06-19 04:21:35 +00:00
chore(docs): update
This commit is contained in:
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: Actions
|
||||
|
||||
Defined in: [src/core/Actions.ts:46](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Actions.ts#L46)
|
||||
Defined in: [src/core/Actions.ts:46](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Actions.ts#L46)
|
||||
|
||||
## Constructors
|
||||
|
||||
@@ -10,7 +10,7 @@ Defined in: [src/core/Actions.ts:46](https://github.com/LuanRT/YouTube.js/blob/0
|
||||
|
||||
> **new Actions**(`session`): `Actions`
|
||||
|
||||
Defined in: [src/core/Actions.ts:49](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Actions.ts#L49)
|
||||
Defined in: [src/core/Actions.ts:49](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Actions.ts#L49)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -28,7 +28,7 @@ Defined in: [src/core/Actions.ts:49](https://github.com/LuanRT/YouTube.js/blob/0
|
||||
|
||||
> **session**: [`Session`](Session.md)
|
||||
|
||||
Defined in: [src/core/Actions.ts:47](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Actions.ts#L47)
|
||||
Defined in: [src/core/Actions.ts:47](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Actions.ts#L47)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -38,7 +38,7 @@ Defined in: [src/core/Actions.ts:47](https://github.com/LuanRT/YouTube.js/blob/0
|
||||
|
||||
> **execute**\<`T`\>(`endpoint`, `args`): `Promise`\<[`ParsedResponse`](../type-aliases/ParsedResponse.md)\<`T`\>\>
|
||||
|
||||
Defined in: [src/core/Actions.ts:81](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Actions.ts#L81)
|
||||
Defined in: [src/core/Actions.ts:81](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Actions.ts#L81)
|
||||
|
||||
Executes an API call.
|
||||
|
||||
@@ -84,7 +84,7 @@ Call arguments
|
||||
|
||||
> **execute**\<`T`\>(`endpoint`, `args?`): `Promise`\<[`ApiResponse`](../interfaces/ApiResponse.md)\>
|
||||
|
||||
Defined in: [src/core/Actions.ts:88](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Actions.ts#L88)
|
||||
Defined in: [src/core/Actions.ts:88](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Actions.ts#L88)
|
||||
|
||||
Executes an API call.
|
||||
|
||||
@@ -132,7 +132,7 @@ Call arguments
|
||||
|
||||
> **stats**(`url`, `client`, `params`): `Promise`\<`Response`\>
|
||||
|
||||
Defined in: [src/core/Actions.ts:59](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Actions.ts#L59)
|
||||
Defined in: [src/core/Actions.ts:59](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Actions.ts#L59)
|
||||
|
||||
Makes calls to the playback tracking API.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: AppendContinuationItemsAction
|
||||
|
||||
Defined in: [src/parser/classes/actions/AppendContinuationItemsAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/actions/AppendContinuationItemsAction.ts#L6)
|
||||
Defined in: [src/parser/classes/actions/AppendContinuationItemsAction.ts:6](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/actions/AppendContinuationItemsAction.ts#L6)
|
||||
|
||||
## Extends
|
||||
|
||||
@@ -14,7 +14,7 @@ Defined in: [src/parser/classes/actions/AppendContinuationItemsAction.ts:6](http
|
||||
|
||||
> **new AppendContinuationItemsAction**(`data`): `AppendContinuationItemsAction`
|
||||
|
||||
Defined in: [src/parser/classes/actions/AppendContinuationItemsAction.ts:12](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/actions/AppendContinuationItemsAction.ts#L12)
|
||||
Defined in: [src/parser/classes/actions/AppendContinuationItemsAction.ts:12](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/actions/AppendContinuationItemsAction.ts#L12)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -36,7 +36,7 @@ Defined in: [src/parser/classes/actions/AppendContinuationItemsAction.ts:12](htt
|
||||
|
||||
> **contents**: [`ObservedArray`](../youtubei.js/namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)\>
|
||||
|
||||
Defined in: [src/parser/classes/actions/AppendContinuationItemsAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/actions/AppendContinuationItemsAction.ts#L9)
|
||||
Defined in: [src/parser/classes/actions/AppendContinuationItemsAction.ts:9](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/actions/AppendContinuationItemsAction.ts#L9)
|
||||
|
||||
***
|
||||
|
||||
@@ -44,7 +44,7 @@ Defined in: [src/parser/classes/actions/AppendContinuationItemsAction.ts:9](http
|
||||
|
||||
> **target**: `string`
|
||||
|
||||
Defined in: [src/parser/classes/actions/AppendContinuationItemsAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/actions/AppendContinuationItemsAction.ts#L10)
|
||||
Defined in: [src/parser/classes/actions/AppendContinuationItemsAction.ts:10](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/actions/AppendContinuationItemsAction.ts#L10)
|
||||
|
||||
***
|
||||
|
||||
@@ -52,7 +52,7 @@ Defined in: [src/parser/classes/actions/AppendContinuationItemsAction.ts:10](htt
|
||||
|
||||
> `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
|
||||
|
||||
@@ -64,7 +64,7 @@ Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> `static` **type**: `string` = `'AppendContinuationItemsAction'`
|
||||
|
||||
Defined in: [src/parser/classes/actions/AppendContinuationItemsAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/actions/AppendContinuationItemsAction.ts#L7)
|
||||
Defined in: [src/parser/classes/actions/AppendContinuationItemsAction.ts:7](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/actions/AppendContinuationItemsAction.ts#L7)
|
||||
|
||||
#### Overrides
|
||||
|
||||
@@ -76,7 +76,7 @@ Defined in: [src/parser/classes/actions/AppendContinuationItemsAction.ts:7](http
|
||||
|
||||
> **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.
|
||||
|
||||
@@ -118,7 +118,7 @@ If the node is not of the given type
|
||||
|
||||
> **hasKey**\<`T`, `R`\>(`key`): `this is AppendContinuationItemsAction & { [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.
|
||||
|
||||
@@ -156,7 +156,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.
|
||||
|
||||
@@ -194,7 +194,7 @@ whether the node is of the given type
|
||||
|
||||
> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/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.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: Continuation
|
||||
|
||||
Defined in: [src/parser/continuations.ts:139](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L139)
|
||||
Defined in: [src/parser/continuations.ts:139](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L139)
|
||||
|
||||
## Extends
|
||||
|
||||
@@ -14,7 +14,7 @@ Defined in: [src/parser/continuations.ts:139](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **new Continuation**(`data`): `Continuation`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:147](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L147)
|
||||
Defined in: [src/parser/continuations.ts:147](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L147)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -36,7 +36,7 @@ Defined in: [src/parser/continuations.ts:147](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **continuation\_type**: `string`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:142](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L142)
|
||||
Defined in: [src/parser/continuations.ts:142](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L142)
|
||||
|
||||
***
|
||||
|
||||
@@ -44,7 +44,7 @@ Defined in: [src/parser/continuations.ts:142](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> `optional` **time\_until\_last\_message\_ms**: `number`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:144](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L144)
|
||||
Defined in: [src/parser/continuations.ts:144](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L144)
|
||||
|
||||
***
|
||||
|
||||
@@ -52,7 +52,7 @@ Defined in: [src/parser/continuations.ts:144](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> `optional` **timeout\_ms**: `number`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:143](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L143)
|
||||
Defined in: [src/parser/continuations.ts:143](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L143)
|
||||
|
||||
***
|
||||
|
||||
@@ -60,7 +60,7 @@ Defined in: [src/parser/continuations.ts:143](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **token**: `string`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:145](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L145)
|
||||
Defined in: [src/parser/continuations.ts:145](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L145)
|
||||
|
||||
***
|
||||
|
||||
@@ -68,7 +68,7 @@ Defined in: [src/parser/continuations.ts:145](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> `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
|
||||
|
||||
@@ -80,7 +80,7 @@ Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> `readonly` `static` **type**: `"continuation"` = `'continuation'`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:140](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L140)
|
||||
Defined in: [src/parser/continuations.ts:140](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L140)
|
||||
|
||||
#### Overrides
|
||||
|
||||
@@ -92,7 +92,7 @@ Defined in: [src/parser/continuations.ts:140](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **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.
|
||||
|
||||
@@ -134,7 +134,7 @@ If the node is not of the given type
|
||||
|
||||
> **hasKey**\<`T`, `R`\>(`key`): `this is Continuation & { [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.
|
||||
|
||||
@@ -172,7 +172,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.
|
||||
|
||||
@@ -210,7 +210,7 @@ whether the node is of the given type
|
||||
|
||||
> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/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.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: ContinuationCommand
|
||||
|
||||
Defined in: [src/parser/continuations.ts:214](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L214)
|
||||
Defined in: [src/parser/continuations.ts:214](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L214)
|
||||
|
||||
## Extends
|
||||
|
||||
@@ -14,7 +14,7 @@ Defined in: [src/parser/continuations.ts:214](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **new ContinuationCommand**(`data`): `ContinuationCommand`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:220](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L220)
|
||||
Defined in: [src/parser/continuations.ts:220](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L220)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -36,7 +36,7 @@ Defined in: [src/parser/continuations.ts:220](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **request**: `string`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:217](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L217)
|
||||
Defined in: [src/parser/continuations.ts:217](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L217)
|
||||
|
||||
***
|
||||
|
||||
@@ -44,7 +44,7 @@ Defined in: [src/parser/continuations.ts:217](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **token**: `string`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:218](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L218)
|
||||
Defined in: [src/parser/continuations.ts:218](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L218)
|
||||
|
||||
***
|
||||
|
||||
@@ -52,7 +52,7 @@ Defined in: [src/parser/continuations.ts:218](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> `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
|
||||
|
||||
@@ -64,7 +64,7 @@ Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> `readonly` `static` **type**: `"ContinuationCommand"` = `'ContinuationCommand'`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:215](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L215)
|
||||
Defined in: [src/parser/continuations.ts:215](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L215)
|
||||
|
||||
#### Overrides
|
||||
|
||||
@@ -76,7 +76,7 @@ Defined in: [src/parser/continuations.ts:215](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **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.
|
||||
|
||||
@@ -118,7 +118,7 @@ If the node is not of the given type
|
||||
|
||||
> **hasKey**\<`T`, `R`\>(`key`): `this is ContinuationCommand & { [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.
|
||||
|
||||
@@ -156,7 +156,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.
|
||||
|
||||
@@ -194,7 +194,7 @@ whether the node is of the given type
|
||||
|
||||
> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/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.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: EventEmitter
|
||||
|
||||
Defined in: [src/utils/EventEmitterLike.ts:3](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/utils/EventEmitterLike.ts#L3)
|
||||
Defined in: [src/utils/EventEmitterLike.ts:3](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/utils/EventEmitterLike.ts#L3)
|
||||
|
||||
## Extends
|
||||
|
||||
@@ -19,7 +19,7 @@ Defined in: [src/utils/EventEmitterLike.ts:3](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **new EventEmitter**(): `EventEmitterLike`
|
||||
|
||||
Defined in: [src/utils/EventEmitterLike.ts:6](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/utils/EventEmitterLike.ts#L6)
|
||||
Defined in: [src/utils/EventEmitterLike.ts:6](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/utils/EventEmitterLike.ts#L6)
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -35,21 +35,9 @@ Defined in: [src/utils/EventEmitterLike.ts:6](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **addEventListener**(`type`, `callback`, `options?`): `void`
|
||||
|
||||
Defined in: node\_modules/typescript/lib/lib.dom.d.ts:8256
|
||||
Defined in: node\_modules/typescript/lib/lib.dom.d.ts:11569
|
||||
|
||||
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
|
||||
|
||||
The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
|
||||
|
||||
When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
|
||||
|
||||
When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.
|
||||
|
||||
When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
|
||||
|
||||
If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
|
||||
|
||||
The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
|
||||
The **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
|
||||
|
||||
[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)
|
||||
|
||||
@@ -81,9 +69,9 @@ The event listener is appended to target's event listener list and is not append
|
||||
|
||||
> **dispatchEvent**(`event`): `boolean`
|
||||
|
||||
Defined in: node\_modules/typescript/lib/lib.dom.d.ts:8262
|
||||
Defined in: node\_modules/typescript/lib/lib.dom.d.ts:11575
|
||||
|
||||
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
|
||||
The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.
|
||||
|
||||
[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)
|
||||
|
||||
@@ -107,7 +95,7 @@ Dispatches a synthetic event event to target and returns true if either event's
|
||||
|
||||
> **emit**(`type`, ...`args`): `void`
|
||||
|
||||
Defined in: [src/utils/EventEmitterLike.ts:10](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/utils/EventEmitterLike.ts#L10)
|
||||
Defined in: [src/utils/EventEmitterLike.ts:10](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/utils/EventEmitterLike.ts#L10)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -129,7 +117,7 @@ Defined in: [src/utils/EventEmitterLike.ts:10](https://github.com/LuanRT/YouTube
|
||||
|
||||
> **off**(`type`, `listener`): `void`
|
||||
|
||||
Defined in: [src/utils/EventEmitterLike.ts:40](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/utils/EventEmitterLike.ts#L40)
|
||||
Defined in: [src/utils/EventEmitterLike.ts:40](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/utils/EventEmitterLike.ts#L40)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -151,7 +139,7 @@ Defined in: [src/utils/EventEmitterLike.ts:40](https://github.com/LuanRT/YouTube
|
||||
|
||||
> **on**(`type`, `listener`): `void`
|
||||
|
||||
Defined in: [src/utils/EventEmitterLike.ts:15](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/utils/EventEmitterLike.ts#L15)
|
||||
Defined in: [src/utils/EventEmitterLike.ts:15](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/utils/EventEmitterLike.ts#L15)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -173,7 +161,7 @@ Defined in: [src/utils/EventEmitterLike.ts:15](https://github.com/LuanRT/YouTube
|
||||
|
||||
> **once**(`type`, `listener`): `void`
|
||||
|
||||
Defined in: [src/utils/EventEmitterLike.ts:27](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/utils/EventEmitterLike.ts#L27)
|
||||
Defined in: [src/utils/EventEmitterLike.ts:27](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/utils/EventEmitterLike.ts#L27)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -195,9 +183,9 @@ Defined in: [src/utils/EventEmitterLike.ts:27](https://github.com/LuanRT/YouTube
|
||||
|
||||
> **removeEventListener**(`type`, `callback`, `options?`): `void`
|
||||
|
||||
Defined in: node\_modules/typescript/lib/lib.dom.d.ts:8268
|
||||
Defined in: node\_modules/typescript/lib/lib.dom.d.ts:11581
|
||||
|
||||
Removes the event listener in target's event listener list with the same type, callback, and options.
|
||||
The **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.
|
||||
|
||||
[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: GridContinuation
|
||||
|
||||
Defined in: [src/parser/continuations.ts:108](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L108)
|
||||
Defined in: [src/parser/continuations.ts:108](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L108)
|
||||
|
||||
## Extends
|
||||
|
||||
@@ -14,7 +14,7 @@ Defined in: [src/parser/continuations.ts:108](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **new GridContinuation**(`data`): `GridContinuation`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:114](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L114)
|
||||
Defined in: [src/parser/continuations.ts:114](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L114)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -36,7 +36,7 @@ Defined in: [src/parser/continuations.ts:114](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **continuation**: `string`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:111](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L111)
|
||||
Defined in: [src/parser/continuations.ts:111](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L111)
|
||||
|
||||
***
|
||||
|
||||
@@ -44,7 +44,7 @@ Defined in: [src/parser/continuations.ts:111](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **items**: [`ObservedArray`](../youtubei.js/namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)\> \| `null`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:112](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L112)
|
||||
Defined in: [src/parser/continuations.ts:112](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L112)
|
||||
|
||||
***
|
||||
|
||||
@@ -52,7 +52,7 @@ Defined in: [src/parser/continuations.ts:112](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> `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
|
||||
|
||||
@@ -64,7 +64,7 @@ Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> `readonly` `static` **type**: `"gridContinuation"` = `'gridContinuation'`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:109](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L109)
|
||||
Defined in: [src/parser/continuations.ts:109](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L109)
|
||||
|
||||
#### Overrides
|
||||
|
||||
@@ -78,7 +78,7 @@ Defined in: [src/parser/continuations.ts:109](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **get** **contents**(): [`ObservedArray`](../youtubei.js/namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)\> \| `null`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:120](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L120)
|
||||
Defined in: [src/parser/continuations.ts:120](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L120)
|
||||
|
||||
##### Returns
|
||||
|
||||
@@ -90,7 +90,7 @@ Defined in: [src/parser/continuations.ts:120](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **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.
|
||||
|
||||
@@ -132,7 +132,7 @@ If the node is not of the given type
|
||||
|
||||
> **hasKey**\<`T`, `R`\>(`key`): `this is GridContinuation & { [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.
|
||||
|
||||
@@ -170,7 +170,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.
|
||||
|
||||
@@ -208,7 +208,7 @@ whether the node is of the given type
|
||||
|
||||
> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/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.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: HTTPClient
|
||||
|
||||
Defined in: [src/utils/HTTPClient.ts:25](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/utils/HTTPClient.ts#L25)
|
||||
Defined in: [src/utils/HTTPClient.ts:25](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/utils/HTTPClient.ts#L25)
|
||||
|
||||
## Constructors
|
||||
|
||||
@@ -10,7 +10,7 @@ Defined in: [src/utils/HTTPClient.ts:25](https://github.com/LuanRT/YouTube.js/bl
|
||||
|
||||
> **new HTTPClient**(`session`, `cookie?`, `fetch?`): `HTTPClient`
|
||||
|
||||
Defined in: [src/utils/HTTPClient.ts:30](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/utils/HTTPClient.ts#L30)
|
||||
Defined in: [src/utils/HTTPClient.ts:30](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/utils/HTTPClient.ts#L30)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -38,13 +38,13 @@ Defined in: [src/utils/HTTPClient.ts:30](https://github.com/LuanRT/YouTube.js/bl
|
||||
|
||||
> **get** **fetch\_function**(): \{(`input`, `init?`): `Promise`\<`Response`\>; (`input`, `init?`): `Promise`\<`Response`\>; \}
|
||||
|
||||
Defined in: [src/utils/HTTPClient.ts:36](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/utils/HTTPClient.ts#L36)
|
||||
Defined in: [src/utils/HTTPClient.ts:36](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/utils/HTTPClient.ts#L36)
|
||||
|
||||
##### Returns
|
||||
|
||||
> (`input`, `init?`): `Promise`\<`Response`\>
|
||||
|
||||
[MDN Reference](https://developer.mozilla.org/docs/Web/API/fetch)
|
||||
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)
|
||||
|
||||
###### Parameters
|
||||
|
||||
@@ -62,7 +62,7 @@ Defined in: [src/utils/HTTPClient.ts:36](https://github.com/LuanRT/YouTube.js/bl
|
||||
|
||||
> (`input`, `init?`): `Promise`\<`Response`\>
|
||||
|
||||
[MDN Reference](https://developer.mozilla.org/docs/Web/API/fetch)
|
||||
[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)
|
||||
|
||||
###### Parameters
|
||||
|
||||
@@ -84,7 +84,7 @@ Defined in: [src/utils/HTTPClient.ts:36](https://github.com/LuanRT/YouTube.js/bl
|
||||
|
||||
> **fetch**(`input`, `init?`): `Promise`\<`Response`\>
|
||||
|
||||
Defined in: [src/utils/HTTPClient.ts:40](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/utils/HTTPClient.ts#L40)
|
||||
Defined in: [src/utils/HTTPClient.ts:40](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/utils/HTTPClient.ts#L40)
|
||||
|
||||
#### Parameters
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: Innertube
|
||||
|
||||
Defined in: [src/Innertube.ts:64](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L64)
|
||||
Defined in: [src/Innertube.ts:64](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L64)
|
||||
|
||||
Provides access to various services and modules in the YouTube API.
|
||||
|
||||
@@ -19,7 +19,7 @@ const innertube = await Innertube.create({ cache: new UniversalCache(true)});
|
||||
|
||||
> **new Innertube**(`session`): `Innertube`
|
||||
|
||||
Defined in: [src/Innertube.ts:67](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L67)
|
||||
Defined in: [src/Innertube.ts:67](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L67)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -39,7 +39,7 @@ Defined in: [src/Innertube.ts:67](https://github.com/LuanRT/YouTube.js/blob/0733
|
||||
|
||||
> **get** **account**(): [`AccountManager`](../youtubei.js/namespaces/Managers/classes/AccountManager.md)
|
||||
|
||||
Defined in: [src/Innertube.ts:609](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L609)
|
||||
Defined in: [src/Innertube.ts:603](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L603)
|
||||
|
||||
An interface for managing and retrieving account information.
|
||||
|
||||
@@ -55,7 +55,7 @@ An interface for managing and retrieving account information.
|
||||
|
||||
> **get** **actions**(): [`Actions`](Actions.md)
|
||||
|
||||
Defined in: [src/Innertube.ts:630](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L630)
|
||||
Defined in: [src/Innertube.ts:624](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L624)
|
||||
|
||||
An internal class used to dispatch requests.
|
||||
|
||||
@@ -71,7 +71,7 @@ An internal class used to dispatch requests.
|
||||
|
||||
> **get** **interact**(): [`InteractionManager`](../youtubei.js/namespaces/Managers/classes/InteractionManager.md)
|
||||
|
||||
Defined in: [src/Innertube.ts:623](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L623)
|
||||
Defined in: [src/Innertube.ts:617](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L617)
|
||||
|
||||
An interface for directly interacting with certain YouTube features.
|
||||
|
||||
@@ -87,7 +87,7 @@ An interface for directly interacting with certain YouTube features.
|
||||
|
||||
> **get** **kids**(): [`Kids`](../youtubei.js/namespaces/Clients/classes/Kids.md)
|
||||
|
||||
Defined in: [src/Innertube.ts:602](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L602)
|
||||
Defined in: [src/Innertube.ts:596](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L596)
|
||||
|
||||
An interface for interacting with YouTube Kids.
|
||||
|
||||
@@ -103,7 +103,7 @@ An interface for interacting with YouTube Kids.
|
||||
|
||||
> **get** **music**(): [`Music`](../youtubei.js/namespaces/Clients/classes/Music.md)
|
||||
|
||||
Defined in: [src/Innertube.ts:588](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L588)
|
||||
Defined in: [src/Innertube.ts:582](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L582)
|
||||
|
||||
An interface for interacting with YouTube Music.
|
||||
|
||||
@@ -119,7 +119,7 @@ An interface for interacting with YouTube Music.
|
||||
|
||||
> **get** **playlist**(): [`PlaylistManager`](../youtubei.js/namespaces/Managers/classes/PlaylistManager.md)
|
||||
|
||||
Defined in: [src/Innertube.ts:616](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L616)
|
||||
Defined in: [src/Innertube.ts:610](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L610)
|
||||
|
||||
An interface for managing playlists.
|
||||
|
||||
@@ -135,7 +135,7 @@ An interface for managing playlists.
|
||||
|
||||
> **get** **session**(): [`Session`](Session.md)
|
||||
|
||||
Defined in: [src/Innertube.ts:637](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L637)
|
||||
Defined in: [src/Innertube.ts:631](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L631)
|
||||
|
||||
The session used by this instance.
|
||||
|
||||
@@ -151,7 +151,7 @@ The session used by this instance.
|
||||
|
||||
> **get** **studio**(): [`Studio`](../youtubei.js/namespaces/Clients/classes/Studio.md)
|
||||
|
||||
Defined in: [src/Innertube.ts:595](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L595)
|
||||
Defined in: [src/Innertube.ts:589](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L589)
|
||||
|
||||
An interface for interacting with YouTube Studio.
|
||||
|
||||
@@ -167,7 +167,7 @@ An interface for interacting with YouTube Studio.
|
||||
|
||||
> **call**\<`T`\>(`endpoint`, `args`): `Promise`\<`T`\>
|
||||
|
||||
Defined in: [src/Innertube.ts:579](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L579)
|
||||
Defined in: [src/Innertube.ts:573](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L573)
|
||||
|
||||
Utility method to call an endpoint without having to use [Actions](Actions.md).
|
||||
|
||||
@@ -197,7 +197,7 @@ Utility method to call an endpoint without having to use [Actions](Actions.md).
|
||||
|
||||
> **call**(`endpoint`, `args?`): `Promise`\<[`ApiResponse`](../interfaces/ApiResponse.md)\>
|
||||
|
||||
Defined in: [src/Innertube.ts:580](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L580)
|
||||
Defined in: [src/Innertube.ts:574](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L574)
|
||||
|
||||
Utility method to call an endpoint without having to use [Actions](Actions.md).
|
||||
|
||||
@@ -221,9 +221,9 @@ Utility method to call an endpoint without having to use [Actions](Actions.md).
|
||||
|
||||
### download()
|
||||
|
||||
> **download**(`video_id`, `options?`): `Promise`\<`ReadableStream`\<`Uint8Array`\>\>
|
||||
> **download**(`video_id`, `options?`): `Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\>
|
||||
|
||||
Defined in: [src/Innertube.ts:477](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L477)
|
||||
Defined in: [src/Innertube.ts:471](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L471)
|
||||
|
||||
Downloads a given video. If all you need the direct download link, see [getStreamingData](#getstreamingdata).
|
||||
If you wish to retrieve the video info too, have a look at [getBasicInfo](#getbasicinfo) or [getInfo](#getinfo).
|
||||
@@ -244,7 +244,7 @@ Download options.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<`ReadableStream`\<`Uint8Array`\>\>
|
||||
`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\>
|
||||
|
||||
***
|
||||
|
||||
@@ -252,7 +252,7 @@ Download options.
|
||||
|
||||
> **getAttestationChallenge**(`engagement_type`, `ids?`): `Promise`\<[`IGetChallengeResponse`](../type-aliases/IGetChallengeResponse.md)\>
|
||||
|
||||
Defined in: [src/Innertube.ts:565](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L565)
|
||||
Defined in: [src/Innertube.ts:559](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L559)
|
||||
|
||||
Fetches an attestation challenge.
|
||||
|
||||
@@ -276,7 +276,7 @@ Fetches an attestation challenge.
|
||||
|
||||
> **getBasicInfo**(`video_id`, `options?`): `Promise`\<[`VideoInfo`](../youtubei.js/namespaces/YT/classes/VideoInfo.md)\>
|
||||
|
||||
Defined in: [src/Innertube.ts:124](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L124)
|
||||
Defined in: [src/Innertube.ts:124](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L124)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -298,7 +298,7 @@ Defined in: [src/Innertube.ts:124](https://github.com/LuanRT/YouTube.js/blob/073
|
||||
|
||||
> **getChannel**(`id`): `Promise`\<[`Channel`](../youtubei.js/namespaces/YT/classes/Channel.md)\>
|
||||
|
||||
Defined in: [src/Innertube.ts:391](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L391)
|
||||
Defined in: [src/Innertube.ts:385](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L385)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -316,7 +316,7 @@ Defined in: [src/Innertube.ts:391](https://github.com/LuanRT/YouTube.js/blob/073
|
||||
|
||||
> **getChannelsFeed**(): `Promise`\<[`Feed`](../youtubei.js/namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../type-aliases/IBrowseResponse.md)\>\>
|
||||
|
||||
Defined in: [src/Innertube.ts:385](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L385)
|
||||
Defined in: [src/Innertube.ts:379](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L379)
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -328,7 +328,7 @@ Defined in: [src/Innertube.ts:385](https://github.com/LuanRT/YouTube.js/blob/073
|
||||
|
||||
> **getComments**(`video_id`, `sort_by?`, `comment_id?`): `Promise`\<[`Comments`](../youtubei.js/namespaces/YT/classes/Comments.md)\>
|
||||
|
||||
Defined in: [src/Innertube.ts:306](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L306)
|
||||
Defined in: [src/Innertube.ts:306](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L306)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -354,7 +354,7 @@ Defined in: [src/Innertube.ts:306](https://github.com/LuanRT/YouTube.js/blob/073
|
||||
|
||||
> **getCourses**(): `Promise`\<[`Feed`](../youtubei.js/namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../type-aliases/IBrowseResponse.md)\>\>
|
||||
|
||||
Defined in: [src/Innertube.ts:373](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L373)
|
||||
Defined in: [src/Innertube.ts:367](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L367)
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -366,7 +366,7 @@ Defined in: [src/Innertube.ts:373](https://github.com/LuanRT/YouTube.js/blob/073
|
||||
|
||||
> **getGuide**(): `Promise`\<[`Guide`](../youtubei.js/namespaces/YT/classes/Guide.md)\>
|
||||
|
||||
Defined in: [src/Innertube.ts:350](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L350)
|
||||
Defined in: [src/Innertube.ts:350](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L350)
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -378,7 +378,7 @@ Defined in: [src/Innertube.ts:350](https://github.com/LuanRT/YouTube.js/blob/073
|
||||
|
||||
> **getHashtag**(`hashtag`): `Promise`\<[`HashtagFeed`](../youtubei.js/namespaces/YT/classes/HashtagFeed.md)\>
|
||||
|
||||
Defined in: [src/Innertube.ts:436](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L436)
|
||||
Defined in: [src/Innertube.ts:430](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L430)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -396,7 +396,7 @@ Defined in: [src/Innertube.ts:436](https://github.com/LuanRT/YouTube.js/blob/073
|
||||
|
||||
> **getHistory**(): `Promise`\<[`History`](../youtubei.js/namespaces/YT/classes/History.md)\>
|
||||
|
||||
Defined in: [src/Innertube.ts:361](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L361)
|
||||
Defined in: [src/Innertube.ts:361](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L361)
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -408,7 +408,7 @@ Defined in: [src/Innertube.ts:361](https://github.com/LuanRT/YouTube.js/blob/073
|
||||
|
||||
> **getHomeFeed**(): `Promise`\<[`HomeFeed`](../youtubei.js/namespaces/YT/classes/HomeFeed.md)\>
|
||||
|
||||
Defined in: [src/Innertube.ts:344](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L344)
|
||||
Defined in: [src/Innertube.ts:344](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L344)
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -420,7 +420,7 @@ Defined in: [src/Innertube.ts:344](https://github.com/LuanRT/YouTube.js/blob/073
|
||||
|
||||
> **getInfo**(`target`, `options?`): `Promise`\<[`VideoInfo`](../youtubei.js/namespaces/YT/classes/VideoInfo.md)\>
|
||||
|
||||
Defined in: [src/Innertube.ts:75](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L75)
|
||||
Defined in: [src/Innertube.ts:75](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L75)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -442,7 +442,7 @@ Defined in: [src/Innertube.ts:75](https://github.com/LuanRT/YouTube.js/blob/0733
|
||||
|
||||
> **getLibrary**(): `Promise`\<[`Library`](../youtubei.js/namespaces/YT/classes/Library.md)\>
|
||||
|
||||
Defined in: [src/Innertube.ts:355](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L355)
|
||||
Defined in: [src/Innertube.ts:355](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L355)
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -454,7 +454,7 @@ Defined in: [src/Innertube.ts:355](https://github.com/LuanRT/YouTube.js/blob/073
|
||||
|
||||
> **getNotifications**(): `Promise`\<[`NotificationsMenu`](../youtubei.js/namespaces/YT/classes/NotificationsMenu.md)\>
|
||||
|
||||
Defined in: [src/Innertube.ts:403](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L403)
|
||||
Defined in: [src/Innertube.ts:397](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L397)
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -466,7 +466,7 @@ Defined in: [src/Innertube.ts:403](https://github.com/LuanRT/YouTube.js/blob/073
|
||||
|
||||
> **getPlaylist**(`id`): `Promise`\<[`Playlist`](../youtubei.js/namespaces/YT/classes/Playlist.md)\>
|
||||
|
||||
Defined in: [src/Innertube.ts:423](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L423)
|
||||
Defined in: [src/Innertube.ts:417](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L417)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -484,7 +484,7 @@ Defined in: [src/Innertube.ts:423](https://github.com/LuanRT/YouTube.js/blob/073
|
||||
|
||||
> **getPlaylists**(): `Promise`\<[`Feed`](../youtubei.js/namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../type-aliases/IBrowseResponse.md)\>\>
|
||||
|
||||
Defined in: [src/Innertube.ts:417](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L417)
|
||||
Defined in: [src/Innertube.ts:411](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L411)
|
||||
|
||||
Retrieves the user's playlists.
|
||||
|
||||
@@ -498,7 +498,7 @@ Retrieves the user's playlists.
|
||||
|
||||
> **getPost**(`post_id`, `channel_id`): `Promise`\<[`Feed`](../youtubei.js/namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../type-aliases/IBrowseResponse.md)\>\>
|
||||
|
||||
Defined in: [src/Innertube.ts:497](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L497)
|
||||
Defined in: [src/Innertube.ts:491](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L491)
|
||||
|
||||
Gets a post page given a post id and the channel id
|
||||
|
||||
@@ -522,7 +522,7 @@ Gets a post page given a post id and the channel id
|
||||
|
||||
> **getPostComments**(`post_id`, `channel_id`, `sort_by?`): `Promise`\<[`Comments`](../youtubei.js/namespaces/YT/classes/Comments.md)\>
|
||||
|
||||
Defined in: [src/Innertube.ts:518](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L518)
|
||||
Defined in: [src/Innertube.ts:512](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L512)
|
||||
|
||||
Gets the comments of a post.
|
||||
|
||||
@@ -550,7 +550,7 @@ Gets the comments of a post.
|
||||
|
||||
> **getSearchSuggestions**(`query`, `previous_query?`): `Promise`\<`string`[]\>
|
||||
|
||||
Defined in: [src/Innertube.ts:277](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L277)
|
||||
Defined in: [src/Innertube.ts:277](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L277)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -572,7 +572,7 @@ Defined in: [src/Innertube.ts:277](https://github.com/LuanRT/YouTube.js/blob/073
|
||||
|
||||
> **getShortsVideoInfo**(`video_id`, `client?`): `Promise`\<[`ShortFormVideoInfo`](../youtubei.js/namespaces/YTShorts/classes/ShortFormVideoInfo.md)\>
|
||||
|
||||
Defined in: [src/Innertube.ts:166](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L166)
|
||||
Defined in: [src/Innertube.ts:166](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L166)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -592,9 +592,9 @@ Defined in: [src/Innertube.ts:166](https://github.com/LuanRT/YouTube.js/blob/073
|
||||
|
||||
### getStreamingData()
|
||||
|
||||
> **getStreamingData**(`video_id`, `options`): `Promise`\<[`Format`](../youtubei.js/namespaces/Misc/classes/Format.md)\>
|
||||
> **getStreamingData**(`video_id`, `options?`): `Promise`\<[`Format`](../youtubei.js/namespaces/Misc/classes/Format.md)\>
|
||||
|
||||
Defined in: [src/Innertube.ts:462](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L462)
|
||||
Defined in: [src/Innertube.ts:456](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L456)
|
||||
|
||||
An alternative to [download](#download).
|
||||
Returns deciphered streaming data.
|
||||
@@ -609,7 +609,7 @@ If you wish to retrieve the video info too, have a look at [getBasicInfo](#getba
|
||||
|
||||
The video id.
|
||||
|
||||
##### options
|
||||
##### options?
|
||||
|
||||
[`FormatOptions`](../youtubei.js/namespaces/Types/interfaces/FormatOptions.md) = `{}`
|
||||
|
||||
@@ -625,7 +625,7 @@ Format options.
|
||||
|
||||
> **getSubscriptionsFeed**(): `Promise`\<[`Feed`](../youtubei.js/namespaces/Mixins/classes/Feed.md)\<[`IBrowseResponse`](../type-aliases/IBrowseResponse.md)\>\>
|
||||
|
||||
Defined in: [src/Innertube.ts:379](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L379)
|
||||
Defined in: [src/Innertube.ts:373](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L373)
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -633,23 +633,11 @@ Defined in: [src/Innertube.ts:379](https://github.com/LuanRT/YouTube.js/blob/073
|
||||
|
||||
***
|
||||
|
||||
### getTrending()
|
||||
|
||||
> **getTrending**(): `Promise`\<[`TabbedFeed`](../youtubei.js/namespaces/Mixins/classes/TabbedFeed.md)\<[`IBrowseResponse`](../type-aliases/IBrowseResponse.md)\>\>
|
||||
|
||||
Defined in: [src/Innertube.ts:367](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L367)
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<[`TabbedFeed`](../youtubei.js/namespaces/Mixins/classes/TabbedFeed.md)\<[`IBrowseResponse`](../type-aliases/IBrowseResponse.md)\>\>
|
||||
|
||||
***
|
||||
|
||||
### getUnseenNotificationsCount()
|
||||
|
||||
> **getUnseenNotificationsCount**(): `Promise`\<`number`\>
|
||||
|
||||
Defined in: [src/Innertube.ts:408](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L408)
|
||||
Defined in: [src/Innertube.ts:402](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L402)
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -661,7 +649,7 @@ Defined in: [src/Innertube.ts:408](https://github.com/LuanRT/YouTube.js/blob/073
|
||||
|
||||
> **resolveURL**(`url`): `Promise`\<[`NavigationEndpoint`](../youtubei.js/namespaces/YTNodes/classes/NavigationEndpoint.md)\>
|
||||
|
||||
Defined in: [src/Innertube.ts:485](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L485)
|
||||
Defined in: [src/Innertube.ts:479](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L479)
|
||||
|
||||
Resolves the given URL.
|
||||
|
||||
@@ -679,9 +667,9 @@ Resolves the given URL.
|
||||
|
||||
### search()
|
||||
|
||||
> **search**(`query`, `filters`): `Promise`\<[`Search`](../youtubei.js/namespaces/YT/classes/Search.md)\>
|
||||
> **search**(`query`, `filters?`): `Promise`\<[`Search`](../youtubei.js/namespaces/YT/classes/Search.md)\>
|
||||
|
||||
Defined in: [src/Innertube.ts:201](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L201)
|
||||
Defined in: [src/Innertube.ts:201](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L201)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -689,7 +677,7 @@ Defined in: [src/Innertube.ts:201](https://github.com/LuanRT/YouTube.js/blob/073
|
||||
|
||||
`string`
|
||||
|
||||
##### filters
|
||||
##### filters?
|
||||
|
||||
[`SearchFilters`](../youtubei.js/namespaces/Types/type-aliases/SearchFilters.md) = `{}`
|
||||
|
||||
@@ -701,13 +689,13 @@ Defined in: [src/Innertube.ts:201](https://github.com/LuanRT/YouTube.js/blob/073
|
||||
|
||||
### create()
|
||||
|
||||
> `static` **create**(`config`): `Promise`\<`Innertube`\>
|
||||
> `static` **create**(`config?`): `Promise`\<`Innertube`\>
|
||||
|
||||
Defined in: [src/Innertube.ts:71](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/Innertube.ts#L71)
|
||||
Defined in: [src/Innertube.ts:71](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/Innertube.ts#L71)
|
||||
|
||||
#### Parameters
|
||||
|
||||
##### config
|
||||
##### config?
|
||||
|
||||
[`SessionOptions`](../type-aliases/SessionOptions.md) = `{}`
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: ItemSectionContinuation
|
||||
|
||||
Defined in: [src/parser/continuations.ts:9](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L9)
|
||||
Defined in: [src/parser/continuations.ts:9](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L9)
|
||||
|
||||
## Extends
|
||||
|
||||
@@ -14,7 +14,7 @@ Defined in: [src/parser/continuations.ts:9](https://github.com/LuanRT/YouTube.js
|
||||
|
||||
> **new ItemSectionContinuation**(`data`): `ItemSectionContinuation`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:15](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L15)
|
||||
Defined in: [src/parser/continuations.ts:15](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L15)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -36,7 +36,7 @@ Defined in: [src/parser/continuations.ts:15](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **contents**: [`ObservedArray`](../youtubei.js/namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)\>
|
||||
|
||||
Defined in: [src/parser/continuations.ts:12](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L12)
|
||||
Defined in: [src/parser/continuations.ts:12](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L12)
|
||||
|
||||
***
|
||||
|
||||
@@ -44,7 +44,7 @@ Defined in: [src/parser/continuations.ts:12](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> `optional` **continuation**: `string`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:13](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L13)
|
||||
Defined in: [src/parser/continuations.ts:13](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L13)
|
||||
|
||||
***
|
||||
|
||||
@@ -52,7 +52,7 @@ Defined in: [src/parser/continuations.ts:13](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> `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
|
||||
|
||||
@@ -64,7 +64,7 @@ Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> `readonly` `static` **type**: `"itemSectionContinuation"` = `'itemSectionContinuation'`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:10](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L10)
|
||||
Defined in: [src/parser/continuations.ts:10](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L10)
|
||||
|
||||
#### Overrides
|
||||
|
||||
@@ -76,7 +76,7 @@ Defined in: [src/parser/continuations.ts:10](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **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.
|
||||
|
||||
@@ -118,7 +118,7 @@ If the node is not of the given type
|
||||
|
||||
> **hasKey**\<`T`, `R`\>(`key`): `this is ItemSectionContinuation & { [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.
|
||||
|
||||
@@ -156,7 +156,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.
|
||||
|
||||
@@ -194,7 +194,7 @@ whether the node is of the given type
|
||||
|
||||
> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/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.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: LiveChatContinuation
|
||||
|
||||
Defined in: [src/parser/continuations.ts:156](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L156)
|
||||
Defined in: [src/parser/continuations.ts:156](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L156)
|
||||
|
||||
## Extends
|
||||
|
||||
@@ -14,7 +14,7 @@ Defined in: [src/parser/continuations.ts:156](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **new LiveChatContinuation**(`data`): `LiveChatContinuation`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:174](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L174)
|
||||
Defined in: [src/parser/continuations.ts:174](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L174)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -36,7 +36,7 @@ Defined in: [src/parser/continuations.ts:174](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **action\_panel**: [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md) \| `null`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:160](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L160)
|
||||
Defined in: [src/parser/continuations.ts:160](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L160)
|
||||
|
||||
***
|
||||
|
||||
@@ -44,7 +44,7 @@ Defined in: [src/parser/continuations.ts:160](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **actions**: [`ObservedArray`](../youtubei.js/namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)\>
|
||||
|
||||
Defined in: [src/parser/continuations.ts:159](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L159)
|
||||
Defined in: [src/parser/continuations.ts:159](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L159)
|
||||
|
||||
***
|
||||
|
||||
@@ -52,7 +52,7 @@ Defined in: [src/parser/continuations.ts:159](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **continuation**: [`Continuation`](Continuation.md)
|
||||
|
||||
Defined in: [src/parser/continuations.ts:171](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L171)
|
||||
Defined in: [src/parser/continuations.ts:171](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L171)
|
||||
|
||||
***
|
||||
|
||||
@@ -60,7 +60,7 @@ Defined in: [src/parser/continuations.ts:171](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **emojis**: `object`[]
|
||||
|
||||
Defined in: [src/parser/continuations.ts:165](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L165)
|
||||
Defined in: [src/parser/continuations.ts:165](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L165)
|
||||
|
||||
#### emoji\_id
|
||||
|
||||
@@ -84,7 +84,7 @@ Defined in: [src/parser/continuations.ts:165](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **header**: [`LiveChatHeader`](../youtubei.js/namespaces/YTNodes/classes/LiveChatHeader.md) \| `null`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:162](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L162)
|
||||
Defined in: [src/parser/continuations.ts:162](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L162)
|
||||
|
||||
***
|
||||
|
||||
@@ -92,7 +92,7 @@ Defined in: [src/parser/continuations.ts:162](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **item\_list**: [`LiveChatItemList`](../youtubei.js/namespaces/YTNodes/classes/LiveChatItemList.md) \| `null`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:161](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L161)
|
||||
Defined in: [src/parser/continuations.ts:161](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L161)
|
||||
|
||||
***
|
||||
|
||||
@@ -100,7 +100,7 @@ Defined in: [src/parser/continuations.ts:161](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **participants\_list**: [`LiveChatParticipantsList`](../youtubei.js/namespaces/YTNodes/classes/LiveChatParticipantsList.md) \| `null`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:163](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L163)
|
||||
Defined in: [src/parser/continuations.ts:163](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L163)
|
||||
|
||||
***
|
||||
|
||||
@@ -108,7 +108,7 @@ Defined in: [src/parser/continuations.ts:163](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **popout\_message**: [`Message`](../youtubei.js/namespaces/YTNodes/classes/Message.md) \| `null`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:164](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L164)
|
||||
Defined in: [src/parser/continuations.ts:164](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L164)
|
||||
|
||||
***
|
||||
|
||||
@@ -116,7 +116,7 @@ Defined in: [src/parser/continuations.ts:164](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> `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
|
||||
|
||||
@@ -128,7 +128,7 @@ Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> **viewer\_name**: `string`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:172](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L172)
|
||||
Defined in: [src/parser/continuations.ts:172](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L172)
|
||||
|
||||
***
|
||||
|
||||
@@ -136,7 +136,7 @@ Defined in: [src/parser/continuations.ts:172](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> `readonly` `static` **type**: `"liveChatContinuation"` = `'liveChatContinuation'`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:157](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L157)
|
||||
Defined in: [src/parser/continuations.ts:157](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L157)
|
||||
|
||||
#### Overrides
|
||||
|
||||
@@ -148,7 +148,7 @@ Defined in: [src/parser/continuations.ts:157](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **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.
|
||||
|
||||
@@ -190,7 +190,7 @@ If the node is not of the given type
|
||||
|
||||
> **hasKey**\<`T`, `R`\>(`key`): `this is LiveChatContinuation & { [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.
|
||||
|
||||
@@ -228,7 +228,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.
|
||||
|
||||
@@ -266,7 +266,7 @@ whether the node is of the given type
|
||||
|
||||
> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/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.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: MusicPlaylistShelfContinuation
|
||||
|
||||
Defined in: [src/parser/continuations.ts:80](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L80)
|
||||
Defined in: [src/parser/continuations.ts:80](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L80)
|
||||
|
||||
## Extends
|
||||
|
||||
@@ -14,7 +14,7 @@ Defined in: [src/parser/continuations.ts:80](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **new MusicPlaylistShelfContinuation**(`data`): `MusicPlaylistShelfContinuation`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:86](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L86)
|
||||
Defined in: [src/parser/continuations.ts:86](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L86)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -36,7 +36,7 @@ Defined in: [src/parser/continuations.ts:86](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **contents**: [`ObservedArray`](../youtubei.js/namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)\> \| `null`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:84](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L84)
|
||||
Defined in: [src/parser/continuations.ts:84](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L84)
|
||||
|
||||
***
|
||||
|
||||
@@ -44,7 +44,7 @@ Defined in: [src/parser/continuations.ts:84](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **continuation**: `string`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:83](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L83)
|
||||
Defined in: [src/parser/continuations.ts:83](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L83)
|
||||
|
||||
***
|
||||
|
||||
@@ -52,7 +52,7 @@ Defined in: [src/parser/continuations.ts:83](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> `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
|
||||
|
||||
@@ -64,7 +64,7 @@ Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> `readonly` `static` **type**: `"musicPlaylistShelfContinuation"` = `'musicPlaylistShelfContinuation'`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:81](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L81)
|
||||
Defined in: [src/parser/continuations.ts:81](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L81)
|
||||
|
||||
#### Overrides
|
||||
|
||||
@@ -76,7 +76,7 @@ Defined in: [src/parser/continuations.ts:81](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **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.
|
||||
|
||||
@@ -118,7 +118,7 @@ If the node is not of the given type
|
||||
|
||||
> **hasKey**\<`T`, `R`\>(`key`): `this is MusicPlaylistShelfContinuation & { [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.
|
||||
|
||||
@@ -156,7 +156,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.
|
||||
|
||||
@@ -194,7 +194,7 @@ whether the node is of the given type
|
||||
|
||||
> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/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.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: MusicShelfContinuation
|
||||
|
||||
Defined in: [src/parser/continuations.ts:93](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L93)
|
||||
Defined in: [src/parser/continuations.ts:93](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L93)
|
||||
|
||||
## Extends
|
||||
|
||||
@@ -14,7 +14,7 @@ Defined in: [src/parser/continuations.ts:93](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **new MusicShelfContinuation**(`data`): `MusicShelfContinuation`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:99](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L99)
|
||||
Defined in: [src/parser/continuations.ts:99](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L99)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -36,7 +36,7 @@ Defined in: [src/parser/continuations.ts:99](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **contents**: [`ObservedArray`](../youtubei.js/namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)\>
|
||||
|
||||
Defined in: [src/parser/continuations.ts:97](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L97)
|
||||
Defined in: [src/parser/continuations.ts:97](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L97)
|
||||
|
||||
***
|
||||
|
||||
@@ -44,7 +44,7 @@ Defined in: [src/parser/continuations.ts:97](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **continuation**: `string`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:96](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L96)
|
||||
Defined in: [src/parser/continuations.ts:96](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L96)
|
||||
|
||||
***
|
||||
|
||||
@@ -52,7 +52,7 @@ Defined in: [src/parser/continuations.ts:96](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> `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
|
||||
|
||||
@@ -64,7 +64,7 @@ Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> `readonly` `static` **type**: `"musicShelfContinuation"` = `'musicShelfContinuation'`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:94](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L94)
|
||||
Defined in: [src/parser/continuations.ts:94](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L94)
|
||||
|
||||
#### Overrides
|
||||
|
||||
@@ -76,7 +76,7 @@ Defined in: [src/parser/continuations.ts:94](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **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.
|
||||
|
||||
@@ -118,7 +118,7 @@ If the node is not of the given type
|
||||
|
||||
> **hasKey**\<`T`, `R`\>(`key`): `this is MusicShelfContinuation & { [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.
|
||||
|
||||
@@ -156,7 +156,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.
|
||||
|
||||
@@ -194,7 +194,7 @@ whether the node is of the given type
|
||||
|
||||
> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/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.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: NavigateAction
|
||||
|
||||
Defined in: [src/parser/continuations.ts:24](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L24)
|
||||
Defined in: [src/parser/continuations.ts:24](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L24)
|
||||
|
||||
## Extends
|
||||
|
||||
@@ -14,7 +14,7 @@ Defined in: [src/parser/continuations.ts:24](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **new NavigateAction**(`data`): `NavigateAction`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:29](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L29)
|
||||
Defined in: [src/parser/continuations.ts:29](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L29)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -36,7 +36,7 @@ Defined in: [src/parser/continuations.ts:29](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **endpoint**: [`NavigationEndpoint`](../youtubei.js/namespaces/YTNodes/classes/NavigationEndpoint.md)
|
||||
|
||||
Defined in: [src/parser/continuations.ts:27](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L27)
|
||||
Defined in: [src/parser/continuations.ts:27](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L27)
|
||||
|
||||
***
|
||||
|
||||
@@ -44,7 +44,7 @@ Defined in: [src/parser/continuations.ts:27](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> `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
|
||||
|
||||
@@ -56,7 +56,7 @@ Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> `readonly` `static` **type**: `"navigateAction"` = `'navigateAction'`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:25](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L25)
|
||||
Defined in: [src/parser/continuations.ts:25](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L25)
|
||||
|
||||
#### Overrides
|
||||
|
||||
@@ -68,7 +68,7 @@ Defined in: [src/parser/continuations.ts:25](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **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.
|
||||
|
||||
@@ -110,7 +110,7 @@ If the node is not of the given type
|
||||
|
||||
> **hasKey**\<`T`, `R`\>(`key`): `this is NavigateAction & { [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.
|
||||
|
||||
@@ -148,7 +148,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.
|
||||
|
||||
@@ -186,7 +186,7 @@ whether the node is of the given type
|
||||
|
||||
> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/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.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: OAuth2
|
||||
|
||||
Defined in: [src/core/OAuth2.ts:35](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L35)
|
||||
Defined in: [src/core/OAuth2.ts:35](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L35)
|
||||
|
||||
## Constructors
|
||||
|
||||
@@ -10,7 +10,7 @@ Defined in: [src/core/OAuth2.ts:35](https://github.com/LuanRT/YouTube.js/blob/07
|
||||
|
||||
> **new OAuth2**(`session`): `OAuth2`
|
||||
|
||||
Defined in: [src/core/OAuth2.ts:46](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L46)
|
||||
Defined in: [src/core/OAuth2.ts:46](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L46)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -28,7 +28,7 @@ Defined in: [src/core/OAuth2.ts:46](https://github.com/LuanRT/YouTube.js/blob/07
|
||||
|
||||
> **AUTH\_SERVER\_CODE\_URL**: `URL`
|
||||
|
||||
Defined in: [src/core/OAuth2.ts:39](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L39)
|
||||
Defined in: [src/core/OAuth2.ts:39](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L39)
|
||||
|
||||
***
|
||||
|
||||
@@ -36,7 +36,7 @@ Defined in: [src/core/OAuth2.ts:39](https://github.com/LuanRT/YouTube.js/blob/07
|
||||
|
||||
> **AUTH\_SERVER\_REVOKE\_TOKEN\_URL**: `URL`
|
||||
|
||||
Defined in: [src/core/OAuth2.ts:41](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L41)
|
||||
Defined in: [src/core/OAuth2.ts:41](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L41)
|
||||
|
||||
***
|
||||
|
||||
@@ -44,7 +44,7 @@ Defined in: [src/core/OAuth2.ts:41](https://github.com/LuanRT/YouTube.js/blob/07
|
||||
|
||||
> **AUTH\_SERVER\_TOKEN\_URL**: `URL`
|
||||
|
||||
Defined in: [src/core/OAuth2.ts:40](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L40)
|
||||
Defined in: [src/core/OAuth2.ts:40](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L40)
|
||||
|
||||
***
|
||||
|
||||
@@ -52,7 +52,7 @@ Defined in: [src/core/OAuth2.ts:40](https://github.com/LuanRT/YouTube.js/blob/07
|
||||
|
||||
> **client\_id**: [`OAuth2ClientID`](../type-aliases/OAuth2ClientID.md) \| `undefined`
|
||||
|
||||
Defined in: [src/core/OAuth2.ts:43](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L43)
|
||||
Defined in: [src/core/OAuth2.ts:43](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L43)
|
||||
|
||||
***
|
||||
|
||||
@@ -60,7 +60,7 @@ Defined in: [src/core/OAuth2.ts:43](https://github.com/LuanRT/YouTube.js/blob/07
|
||||
|
||||
> **oauth2\_tokens**: [`OAuth2Tokens`](../type-aliases/OAuth2Tokens.md) \| `undefined`
|
||||
|
||||
Defined in: [src/core/OAuth2.ts:44](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L44)
|
||||
Defined in: [src/core/OAuth2.ts:44](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L44)
|
||||
|
||||
***
|
||||
|
||||
@@ -68,7 +68,7 @@ Defined in: [src/core/OAuth2.ts:44](https://github.com/LuanRT/YouTube.js/blob/07
|
||||
|
||||
> **YTTV\_URL**: `URL`
|
||||
|
||||
Defined in: [src/core/OAuth2.ts:38](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L38)
|
||||
Defined in: [src/core/OAuth2.ts:38](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L38)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -76,7 +76,7 @@ Defined in: [src/core/OAuth2.ts:38](https://github.com/LuanRT/YouTube.js/blob/07
|
||||
|
||||
> **cacheCredentials**(): `Promise`\<`void`\>
|
||||
|
||||
Defined in: [src/core/OAuth2.ts:105](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L105)
|
||||
Defined in: [src/core/OAuth2.ts:105](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L105)
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -88,7 +88,7 @@ Defined in: [src/core/OAuth2.ts:105](https://github.com/LuanRT/YouTube.js/blob/0
|
||||
|
||||
> **getClientID**(): `Promise`\<[`OAuth2ClientID`](../type-aliases/OAuth2ClientID.md)\>
|
||||
|
||||
Defined in: [src/core/OAuth2.ts:268](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L268)
|
||||
Defined in: [src/core/OAuth2.ts:268](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L268)
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -100,7 +100,7 @@ Defined in: [src/core/OAuth2.ts:268](https://github.com/LuanRT/YouTube.js/blob/0
|
||||
|
||||
> **getDeviceAndUserCode**(): `Promise`\<[`DeviceAndUserCode`](../type-aliases/DeviceAndUserCode.md)\>
|
||||
|
||||
Defined in: [src/core/OAuth2.ts:236](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L236)
|
||||
Defined in: [src/core/OAuth2.ts:236](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L236)
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -112,7 +112,7 @@ Defined in: [src/core/OAuth2.ts:236](https://github.com/LuanRT/YouTube.js/blob/0
|
||||
|
||||
> **init**(`tokens?`): `Promise`\<`void`\>
|
||||
|
||||
Defined in: [src/core/OAuth2.ts:54](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L54)
|
||||
Defined in: [src/core/OAuth2.ts:54](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L54)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -130,7 +130,7 @@ Defined in: [src/core/OAuth2.ts:54](https://github.com/LuanRT/YouTube.js/blob/07
|
||||
|
||||
> **pollForAccessToken**(`device_and_user_code`): `void`
|
||||
|
||||
Defined in: [src/core/OAuth2.ts:130](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L130)
|
||||
Defined in: [src/core/OAuth2.ts:130](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L130)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -148,7 +148,7 @@ Defined in: [src/core/OAuth2.ts:130](https://github.com/LuanRT/YouTube.js/blob/0
|
||||
|
||||
> **refreshAccessToken**(): `Promise`\<`void`\>
|
||||
|
||||
Defined in: [src/core/OAuth2.ts:197](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L197)
|
||||
Defined in: [src/core/OAuth2.ts:197](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L197)
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -160,7 +160,7 @@ Defined in: [src/core/OAuth2.ts:197](https://github.com/LuanRT/YouTube.js/blob/0
|
||||
|
||||
> **removeCache**(): `Promise`\<`void`\>
|
||||
|
||||
Defined in: [src/core/OAuth2.ts:126](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L126)
|
||||
Defined in: [src/core/OAuth2.ts:126](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L126)
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -172,7 +172,7 @@ Defined in: [src/core/OAuth2.ts:126](https://github.com/LuanRT/YouTube.js/blob/0
|
||||
|
||||
> **revokeCredentials**(): `Promise`\<`Response` \| `undefined`\>
|
||||
|
||||
Defined in: [src/core/OAuth2.ts:185](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L185)
|
||||
Defined in: [src/core/OAuth2.ts:185](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L185)
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -184,7 +184,7 @@ Defined in: [src/core/OAuth2.ts:185](https://github.com/LuanRT/YouTube.js/blob/0
|
||||
|
||||
> **setTokens**(`tokens`): `void`
|
||||
|
||||
Defined in: [src/core/OAuth2.ts:85](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L85)
|
||||
Defined in: [src/core/OAuth2.ts:85](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L85)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -202,7 +202,7 @@ Defined in: [src/core/OAuth2.ts:85](https://github.com/LuanRT/YouTube.js/blob/07
|
||||
|
||||
> **shouldRefreshToken**(): `boolean`
|
||||
|
||||
Defined in: [src/core/OAuth2.ts:313](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L313)
|
||||
Defined in: [src/core/OAuth2.ts:313](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L313)
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -214,7 +214,7 @@ Defined in: [src/core/OAuth2.ts:313](https://github.com/LuanRT/YouTube.js/blob/0
|
||||
|
||||
> **validateTokens**(`tokens`): `boolean`
|
||||
|
||||
Defined in: [src/core/OAuth2.ts:319](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L319)
|
||||
Defined in: [src/core/OAuth2.ts:319](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L319)
|
||||
|
||||
#### Parameters
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: Platform
|
||||
|
||||
Defined in: [src/utils/Utils.ts:15](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/utils/Utils.ts#L15)
|
||||
Defined in: [src/utils/Utils.ts:15](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/utils/Utils.ts#L15)
|
||||
|
||||
## Constructors
|
||||
|
||||
@@ -22,7 +22,7 @@ Defined in: [src/utils/Utils.ts:15](https://github.com/LuanRT/YouTube.js/blob/07
|
||||
|
||||
> **get** `static` **shim**(): [`PlatformShim`](../youtubei.js/namespaces/Types/interfaces/PlatformShim.md)
|
||||
|
||||
Defined in: [src/utils/Utils.ts:20](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/utils/Utils.ts#L20)
|
||||
Defined in: [src/utils/Utils.ts:20](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/utils/Utils.ts#L20)
|
||||
|
||||
##### Returns
|
||||
|
||||
@@ -34,7 +34,7 @@ Defined in: [src/utils/Utils.ts:20](https://github.com/LuanRT/YouTube.js/blob/07
|
||||
|
||||
> `static` **load**(`platform`): `void`
|
||||
|
||||
Defined in: [src/utils/Utils.ts:16](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/utils/Utils.ts#L16)
|
||||
Defined in: [src/utils/Utils.ts:16](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/utils/Utils.ts#L16)
|
||||
|
||||
#### Parameters
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: Player
|
||||
|
||||
Defined in: [src/core/Player.ts:37](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Player.ts#L37)
|
||||
Defined in: [src/core/Player.ts:38](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Player.ts#L38)
|
||||
|
||||
Represents YouTube's player script. This is required to decipher signatures.
|
||||
|
||||
@@ -12,7 +12,7 @@ Represents YouTube's player script. This is required to decipher signatures.
|
||||
|
||||
> **new Player**(`player_id`, `signature_timestamp`, `data?`): `Player`
|
||||
|
||||
Defined in: [src/core/Player.ts:40](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Player.ts#L40)
|
||||
Defined in: [src/core/Player.ts:41](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Player.ts#L41)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -38,7 +38,7 @@ Defined in: [src/core/Player.ts:40](https://github.com/LuanRT/YouTube.js/blob/07
|
||||
|
||||
> `optional` **data**: [`BuildScriptResult`](../youtubei.js/namespaces/Types/interfaces/BuildScriptResult.md)
|
||||
|
||||
Defined in: [src/core/Player.ts:40](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Player.ts#L40)
|
||||
Defined in: [src/core/Player.ts:41](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Player.ts#L41)
|
||||
|
||||
***
|
||||
|
||||
@@ -46,7 +46,7 @@ Defined in: [src/core/Player.ts:40](https://github.com/LuanRT/YouTube.js/blob/07
|
||||
|
||||
> **player\_id**: `string`
|
||||
|
||||
Defined in: [src/core/Player.ts:40](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Player.ts#L40)
|
||||
Defined in: [src/core/Player.ts:41](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Player.ts#L41)
|
||||
|
||||
***
|
||||
|
||||
@@ -54,7 +54,7 @@ Defined in: [src/core/Player.ts:40](https://github.com/LuanRT/YouTube.js/blob/07
|
||||
|
||||
> `optional` **po\_token**: `string`
|
||||
|
||||
Defined in: [src/core/Player.ts:38](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Player.ts#L38)
|
||||
Defined in: [src/core/Player.ts:39](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Player.ts#L39)
|
||||
|
||||
***
|
||||
|
||||
@@ -62,7 +62,7 @@ Defined in: [src/core/Player.ts:38](https://github.com/LuanRT/YouTube.js/blob/07
|
||||
|
||||
> **signature\_timestamp**: `number`
|
||||
|
||||
Defined in: [src/core/Player.ts:40](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Player.ts#L40)
|
||||
Defined in: [src/core/Player.ts:41](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Player.ts#L41)
|
||||
|
||||
## Accessors
|
||||
|
||||
@@ -72,7 +72,7 @@ Defined in: [src/core/Player.ts:40](https://github.com/LuanRT/YouTube.js/blob/07
|
||||
|
||||
> **get** **url**(): `string`
|
||||
|
||||
Defined in: [src/core/Player.ts:284](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Player.ts#L284)
|
||||
Defined in: [src/core/Player.ts:285](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Player.ts#L285)
|
||||
|
||||
##### Returns
|
||||
|
||||
@@ -86,7 +86,7 @@ Defined in: [src/core/Player.ts:284](https://github.com/LuanRT/YouTube.js/blob/0
|
||||
|
||||
> **get** `static` **LIBRARY\_VERSION**(): `number`
|
||||
|
||||
Defined in: [src/core/Player.ts:288](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Player.ts#L288)
|
||||
Defined in: [src/core/Player.ts:289](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Player.ts#L289)
|
||||
|
||||
##### Returns
|
||||
|
||||
@@ -98,7 +98,7 @@ Defined in: [src/core/Player.ts:288](https://github.com/LuanRT/YouTube.js/blob/0
|
||||
|
||||
> **cache**(`cache?`): `Promise`\<`void`\>
|
||||
|
||||
Defined in: [src/core/Player.ts:270](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Player.ts#L270)
|
||||
Defined in: [src/core/Player.ts:271](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Player.ts#L271)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -116,7 +116,7 @@ Defined in: [src/core/Player.ts:270](https://github.com/LuanRT/YouTube.js/blob/0
|
||||
|
||||
> **decipher**(`url?`, `signature_cipher?`, `cipher?`, `this_response_nsig_cache?`): `Promise`\<`string`\>
|
||||
|
||||
Defined in: [src/core/Player.ts:134](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Player.ts#L134)
|
||||
Defined in: [src/core/Player.ts:129](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Player.ts#L129)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -144,9 +144,9 @@ Defined in: [src/core/Player.ts:134](https://github.com/LuanRT/YouTube.js/blob/0
|
||||
|
||||
### create()
|
||||
|
||||
> `static` **create**(`cache`, `fetch`, `po_token?`, `player_id?`): `Promise`\<`Player`\>
|
||||
> `static` **create**(`cache`, `fetch?`, `po_token?`, `player_id?`): `Promise`\<`Player`\>
|
||||
|
||||
Defined in: [src/core/Player.ts:42](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Player.ts#L42)
|
||||
Defined in: [src/core/Player.ts:43](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Player.ts#L43)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -154,7 +154,7 @@ Defined in: [src/core/Player.ts:42](https://github.com/LuanRT/YouTube.js/blob/07
|
||||
|
||||
[`ICache`](../youtubei.js/namespaces/Types/interfaces/ICache.md) | `undefined`
|
||||
|
||||
##### fetch
|
||||
##### fetch?
|
||||
|
||||
\{(`input`, `init?`): `Promise`\<`Response`\>; (`input`, `init?`): `Promise`\<`Response`\>; \}
|
||||
|
||||
@@ -176,7 +176,7 @@ Defined in: [src/core/Player.ts:42](https://github.com/LuanRT/YouTube.js/blob/07
|
||||
|
||||
> `static` **fromCache**(`cache`, `player_id`): `Promise`\<`Player` \| `null`\>
|
||||
|
||||
Defined in: [src/core/Player.ts:243](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Player.ts#L243)
|
||||
Defined in: [src/core/Player.ts:244](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Player.ts#L244)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -198,7 +198,7 @@ Defined in: [src/core/Player.ts:243](https://github.com/LuanRT/YouTube.js/blob/0
|
||||
|
||||
> `static` **fromSource**(`player_id`, `options`): `Promise`\<`Player`\>
|
||||
|
||||
Defined in: [src/core/Player.ts:264](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Player.ts#L264)
|
||||
Defined in: [src/core/Player.ts:265](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Player.ts#L265)
|
||||
|
||||
#### Parameters
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: PlaylistPanelContinuation
|
||||
|
||||
Defined in: [src/parser/continuations.ts:125](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L125)
|
||||
Defined in: [src/parser/continuations.ts:125](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L125)
|
||||
|
||||
## Extends
|
||||
|
||||
@@ -14,7 +14,7 @@ Defined in: [src/parser/continuations.ts:125](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **new PlaylistPanelContinuation**(`data`): `PlaylistPanelContinuation`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:131](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L131)
|
||||
Defined in: [src/parser/continuations.ts:131](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L131)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -36,7 +36,7 @@ Defined in: [src/parser/continuations.ts:131](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **contents**: [`ObservedArray`](../youtubei.js/namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)\>
|
||||
|
||||
Defined in: [src/parser/continuations.ts:129](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L129)
|
||||
Defined in: [src/parser/continuations.ts:129](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L129)
|
||||
|
||||
***
|
||||
|
||||
@@ -44,7 +44,7 @@ Defined in: [src/parser/continuations.ts:129](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **continuation**: `string`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:128](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L128)
|
||||
Defined in: [src/parser/continuations.ts:128](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L128)
|
||||
|
||||
***
|
||||
|
||||
@@ -52,7 +52,7 @@ Defined in: [src/parser/continuations.ts:128](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> `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
|
||||
|
||||
@@ -64,7 +64,7 @@ Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> `readonly` `static` **type**: `"playlistPanelContinuation"` = `'playlistPanelContinuation'`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:126](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L126)
|
||||
Defined in: [src/parser/continuations.ts:126](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L126)
|
||||
|
||||
#### Overrides
|
||||
|
||||
@@ -76,7 +76,7 @@ Defined in: [src/parser/continuations.ts:126](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **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.
|
||||
|
||||
@@ -118,7 +118,7 @@ If the node is not of the given type
|
||||
|
||||
> **hasKey**\<`T`, `R`\>(`key`): `this is PlaylistPanelContinuation & { [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.
|
||||
|
||||
@@ -156,7 +156,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.
|
||||
|
||||
@@ -194,7 +194,7 @@ whether the node is of the given type
|
||||
|
||||
> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/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.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: ReloadContinuationItemsCommand
|
||||
|
||||
Defined in: [src/parser/continuations.ts:50](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L50)
|
||||
Defined in: [src/parser/continuations.ts:50](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L50)
|
||||
|
||||
## Extends
|
||||
|
||||
@@ -14,7 +14,7 @@ Defined in: [src/parser/continuations.ts:50](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **new ReloadContinuationItemsCommand**(`data`): `ReloadContinuationItemsCommand`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:57](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L57)
|
||||
Defined in: [src/parser/continuations.ts:57](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L57)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -36,7 +36,7 @@ Defined in: [src/parser/continuations.ts:57](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **contents**: [`ObservedArray`](../youtubei.js/namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)\> \| `null`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:54](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L54)
|
||||
Defined in: [src/parser/continuations.ts:54](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L54)
|
||||
|
||||
***
|
||||
|
||||
@@ -44,7 +44,7 @@ Defined in: [src/parser/continuations.ts:54](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> `optional` **slot**: `string`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:55](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L55)
|
||||
Defined in: [src/parser/continuations.ts:55](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L55)
|
||||
|
||||
***
|
||||
|
||||
@@ -52,7 +52,7 @@ Defined in: [src/parser/continuations.ts:55](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **target\_id**: `string`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:53](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L53)
|
||||
Defined in: [src/parser/continuations.ts:53](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L53)
|
||||
|
||||
***
|
||||
|
||||
@@ -60,7 +60,7 @@ Defined in: [src/parser/continuations.ts:53](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> `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
|
||||
|
||||
@@ -72,7 +72,7 @@ Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> `readonly` `static` **type**: `"reloadContinuationItemsCommand"` = `'reloadContinuationItemsCommand'`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:51](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L51)
|
||||
Defined in: [src/parser/continuations.ts:51](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L51)
|
||||
|
||||
#### Overrides
|
||||
|
||||
@@ -84,7 +84,7 @@ Defined in: [src/parser/continuations.ts:51](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **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.
|
||||
|
||||
@@ -126,7 +126,7 @@ If the node is not of the given type
|
||||
|
||||
> **hasKey**\<`T`, `R`\>(`key`): `this is ReloadContinuationItemsCommand & { [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.
|
||||
|
||||
@@ -164,7 +164,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.
|
||||
|
||||
@@ -202,7 +202,7 @@ whether the node is of the given type
|
||||
|
||||
> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/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.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: SectionListContinuation
|
||||
|
||||
Defined in: [src/parser/continuations.ts:65](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L65)
|
||||
Defined in: [src/parser/continuations.ts:65](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L65)
|
||||
|
||||
## Extends
|
||||
|
||||
@@ -14,7 +14,7 @@ Defined in: [src/parser/continuations.ts:65](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **new SectionListContinuation**(`data`): `SectionListContinuation`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:71](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L71)
|
||||
Defined in: [src/parser/continuations.ts:71](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L71)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -36,7 +36,7 @@ Defined in: [src/parser/continuations.ts:71](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **contents**: [`ObservedArray`](../youtubei.js/namespaces/Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)\> \| `null`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:69](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L69)
|
||||
Defined in: [src/parser/continuations.ts:69](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L69)
|
||||
|
||||
***
|
||||
|
||||
@@ -44,7 +44,7 @@ Defined in: [src/parser/continuations.ts:69](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **continuation**: `string`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:68](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L68)
|
||||
Defined in: [src/parser/continuations.ts:68](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L68)
|
||||
|
||||
***
|
||||
|
||||
@@ -52,7 +52,7 @@ Defined in: [src/parser/continuations.ts:68](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> `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
|
||||
|
||||
@@ -64,7 +64,7 @@ Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> `readonly` `static` **type**: `"sectionListContinuation"` = `'sectionListContinuation'`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:66](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L66)
|
||||
Defined in: [src/parser/continuations.ts:66](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L66)
|
||||
|
||||
#### Overrides
|
||||
|
||||
@@ -76,7 +76,7 @@ Defined in: [src/parser/continuations.ts:66](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **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.
|
||||
|
||||
@@ -118,7 +118,7 @@ If the node is not of the given type
|
||||
|
||||
> **hasKey**\<`T`, `R`\>(`key`): `this is SectionListContinuation & { [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.
|
||||
|
||||
@@ -156,7 +156,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.
|
||||
|
||||
@@ -194,7 +194,7 @@ whether the node is of the given type
|
||||
|
||||
> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/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.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: Session
|
||||
|
||||
Defined in: [src/core/Session.ts:251](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L251)
|
||||
Defined in: [src/core/Session.ts:257](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L257)
|
||||
|
||||
Represents an InnerTube session. This holds all the data needed to make requests to YouTube.
|
||||
|
||||
@@ -16,7 +16,7 @@ Represents an InnerTube session. This holds all the data needed to make requests
|
||||
|
||||
> **new Session**(`context`, `api_key`, `api_version`, `account_index`, `config_data?`, `player?`, `cookie?`, `fetch?`, `cache?`, `po_token?`): `Session`
|
||||
|
||||
Defined in: [src/core/Session.ts:258](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L258)
|
||||
Defined in: [src/core/Session.ts:264](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L264)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -74,7 +74,7 @@ Defined in: [src/core/Session.ts:258](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> **account\_index**: `number`
|
||||
|
||||
Defined in: [src/core/Session.ts:262](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L262)
|
||||
Defined in: [src/core/Session.ts:268](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L268)
|
||||
|
||||
***
|
||||
|
||||
@@ -82,7 +82,7 @@ Defined in: [src/core/Session.ts:262](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> **actions**: [`Actions`](Actions.md)
|
||||
|
||||
Defined in: [src/core/Session.ts:255](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L255)
|
||||
Defined in: [src/core/Session.ts:261](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L261)
|
||||
|
||||
***
|
||||
|
||||
@@ -90,7 +90,7 @@ Defined in: [src/core/Session.ts:255](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> **api\_key**: `string`
|
||||
|
||||
Defined in: [src/core/Session.ts:260](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L260)
|
||||
Defined in: [src/core/Session.ts:266](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L266)
|
||||
|
||||
***
|
||||
|
||||
@@ -98,7 +98,7 @@ Defined in: [src/core/Session.ts:260](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> **api\_version**: `string`
|
||||
|
||||
Defined in: [src/core/Session.ts:261](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L261)
|
||||
Defined in: [src/core/Session.ts:267](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L267)
|
||||
|
||||
***
|
||||
|
||||
@@ -106,7 +106,7 @@ Defined in: [src/core/Session.ts:261](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> `optional` **cache**: [`ICache`](../youtubei.js/namespaces/Types/interfaces/ICache.md)
|
||||
|
||||
Defined in: [src/core/Session.ts:267](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L267)
|
||||
Defined in: [src/core/Session.ts:273](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L273)
|
||||
|
||||
***
|
||||
|
||||
@@ -114,7 +114,7 @@ Defined in: [src/core/Session.ts:267](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> `optional` **config\_data**: `string`
|
||||
|
||||
Defined in: [src/core/Session.ts:263](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L263)
|
||||
Defined in: [src/core/Session.ts:269](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L269)
|
||||
|
||||
***
|
||||
|
||||
@@ -122,7 +122,7 @@ Defined in: [src/core/Session.ts:263](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> **context**: [`Context`](../type-aliases/Context.md)
|
||||
|
||||
Defined in: [src/core/Session.ts:259](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L259)
|
||||
Defined in: [src/core/Session.ts:265](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L265)
|
||||
|
||||
***
|
||||
|
||||
@@ -130,7 +130,7 @@ Defined in: [src/core/Session.ts:259](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> `optional` **cookie**: `string`
|
||||
|
||||
Defined in: [src/core/Session.ts:265](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L265)
|
||||
Defined in: [src/core/Session.ts:271](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L271)
|
||||
|
||||
***
|
||||
|
||||
@@ -138,7 +138,7 @@ Defined in: [src/core/Session.ts:265](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> **http**: [`HTTPClient`](HTTPClient.md)
|
||||
|
||||
Defined in: [src/core/Session.ts:253](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L253)
|
||||
Defined in: [src/core/Session.ts:259](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L259)
|
||||
|
||||
***
|
||||
|
||||
@@ -146,7 +146,7 @@ Defined in: [src/core/Session.ts:253](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> **logged\_in**: `boolean`
|
||||
|
||||
Defined in: [src/core/Session.ts:254](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L254)
|
||||
Defined in: [src/core/Session.ts:260](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L260)
|
||||
|
||||
***
|
||||
|
||||
@@ -154,7 +154,7 @@ Defined in: [src/core/Session.ts:254](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> **oauth**: [`OAuth2`](OAuth2.md)
|
||||
|
||||
Defined in: [src/core/Session.ts:252](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L252)
|
||||
Defined in: [src/core/Session.ts:258](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L258)
|
||||
|
||||
***
|
||||
|
||||
@@ -162,7 +162,7 @@ Defined in: [src/core/Session.ts:252](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> `optional` **player**: [`Player`](Player.md)
|
||||
|
||||
Defined in: [src/core/Session.ts:264](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L264)
|
||||
Defined in: [src/core/Session.ts:270](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L270)
|
||||
|
||||
***
|
||||
|
||||
@@ -170,7 +170,7 @@ Defined in: [src/core/Session.ts:264](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> `optional` **po\_token**: `string`
|
||||
|
||||
Defined in: [src/core/Session.ts:268](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L268)
|
||||
Defined in: [src/core/Session.ts:274](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L274)
|
||||
|
||||
***
|
||||
|
||||
@@ -178,7 +178,7 @@ Defined in: [src/core/Session.ts:268](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> `optional` **user\_agent**: `string`
|
||||
|
||||
Defined in: [src/core/Session.ts:256](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L256)
|
||||
Defined in: [src/core/Session.ts:262](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L262)
|
||||
|
||||
## Accessors
|
||||
|
||||
@@ -188,7 +188,7 @@ Defined in: [src/core/Session.ts:256](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> **get** **client\_name**(): `string`
|
||||
|
||||
Defined in: [src/core/Session.ts:688](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L688)
|
||||
Defined in: [src/core/Session.ts:698](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L698)
|
||||
|
||||
##### Returns
|
||||
|
||||
@@ -202,7 +202,7 @@ Defined in: [src/core/Session.ts:688](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> **get** **client\_version**(): `string`
|
||||
|
||||
Defined in: [src/core/Session.ts:684](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L684)
|
||||
Defined in: [src/core/Session.ts:694](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L694)
|
||||
|
||||
##### Returns
|
||||
|
||||
@@ -216,7 +216,7 @@ Defined in: [src/core/Session.ts:684](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> **get** **lang**(): `string`
|
||||
|
||||
Defined in: [src/core/Session.ts:692](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L692)
|
||||
Defined in: [src/core/Session.ts:702](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L702)
|
||||
|
||||
##### Returns
|
||||
|
||||
@@ -228,21 +228,9 @@ Defined in: [src/core/Session.ts:692](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> **addEventListener**(`type`, `callback`, `options?`): `void`
|
||||
|
||||
Defined in: node\_modules/typescript/lib/lib.dom.d.ts:8256
|
||||
Defined in: node\_modules/typescript/lib/lib.dom.d.ts:11569
|
||||
|
||||
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
|
||||
|
||||
The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
|
||||
|
||||
When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
|
||||
|
||||
When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.
|
||||
|
||||
When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
|
||||
|
||||
If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
|
||||
|
||||
The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
|
||||
The **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
|
||||
|
||||
[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)
|
||||
|
||||
@@ -274,9 +262,9 @@ The event listener is appended to target's event listener list and is not append
|
||||
|
||||
> **dispatchEvent**(`event`): `boolean`
|
||||
|
||||
Defined in: node\_modules/typescript/lib/lib.dom.d.ts:8262
|
||||
Defined in: node\_modules/typescript/lib/lib.dom.d.ts:11575
|
||||
|
||||
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
|
||||
The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.
|
||||
|
||||
[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)
|
||||
|
||||
@@ -300,7 +288,7 @@ Dispatches a synthetic event event to target and returns true if either event's
|
||||
|
||||
> **emit**(`type`, ...`args`): `void`
|
||||
|
||||
Defined in: [src/utils/EventEmitterLike.ts:10](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/utils/EventEmitterLike.ts#L10)
|
||||
Defined in: [src/utils/EventEmitterLike.ts:10](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/utils/EventEmitterLike.ts#L10)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -326,7 +314,7 @@ Defined in: [src/utils/EventEmitterLike.ts:10](https://github.com/LuanRT/YouTube
|
||||
|
||||
> **off**(`type`, `listener`): `void`
|
||||
|
||||
Defined in: [src/utils/EventEmitterLike.ts:40](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/utils/EventEmitterLike.ts#L40)
|
||||
Defined in: [src/utils/EventEmitterLike.ts:40](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/utils/EventEmitterLike.ts#L40)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -354,7 +342,7 @@ Defined in: [src/utils/EventEmitterLike.ts:40](https://github.com/LuanRT/YouTube
|
||||
|
||||
> **on**(`type`, `listener`): `void`
|
||||
|
||||
Defined in: [src/core/Session.ts:278](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L278)
|
||||
Defined in: [src/core/Session.ts:284](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L284)
|
||||
|
||||
##### Parameters
|
||||
|
||||
@@ -378,7 +366,7 @@ Defined in: [src/core/Session.ts:278](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> **on**(`type`, `listener`): `void`
|
||||
|
||||
Defined in: [src/core/Session.ts:279](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L279)
|
||||
Defined in: [src/core/Session.ts:285](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L285)
|
||||
|
||||
##### Parameters
|
||||
|
||||
@@ -402,7 +390,7 @@ Defined in: [src/core/Session.ts:279](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> **on**(`type`, `listener`): `void`
|
||||
|
||||
Defined in: [src/core/Session.ts:280](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L280)
|
||||
Defined in: [src/core/Session.ts:286](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L286)
|
||||
|
||||
##### Parameters
|
||||
|
||||
@@ -426,7 +414,7 @@ Defined in: [src/core/Session.ts:280](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> **on**(`type`, `listener`): `void`
|
||||
|
||||
Defined in: [src/core/Session.ts:281](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L281)
|
||||
Defined in: [src/core/Session.ts:287](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L287)
|
||||
|
||||
##### Parameters
|
||||
|
||||
@@ -454,7 +442,7 @@ Defined in: [src/core/Session.ts:281](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> **once**(`type`, `listener`): `void`
|
||||
|
||||
Defined in: [src/core/Session.ts:287](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L287)
|
||||
Defined in: [src/core/Session.ts:293](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L293)
|
||||
|
||||
##### Parameters
|
||||
|
||||
@@ -478,7 +466,7 @@ Defined in: [src/core/Session.ts:287](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> **once**(`type`, `listener`): `void`
|
||||
|
||||
Defined in: [src/core/Session.ts:288](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L288)
|
||||
Defined in: [src/core/Session.ts:294](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L294)
|
||||
|
||||
##### Parameters
|
||||
|
||||
@@ -502,7 +490,7 @@ Defined in: [src/core/Session.ts:288](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> **once**(`type`, `listener`): `void`
|
||||
|
||||
Defined in: [src/core/Session.ts:289](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L289)
|
||||
Defined in: [src/core/Session.ts:295](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L295)
|
||||
|
||||
##### Parameters
|
||||
|
||||
@@ -528,9 +516,9 @@ Defined in: [src/core/Session.ts:289](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> **removeEventListener**(`type`, `callback`, `options?`): `void`
|
||||
|
||||
Defined in: node\_modules/typescript/lib/lib.dom.d.ts:8268
|
||||
Defined in: node\_modules/typescript/lib/lib.dom.d.ts:11581
|
||||
|
||||
Removes the event listener in target's event listener list with the same type, callback, and options.
|
||||
The **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.
|
||||
|
||||
[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)
|
||||
|
||||
@@ -562,7 +550,7 @@ Removes the event listener in target's event listener list with the same type, c
|
||||
|
||||
> **signIn**(`credentials?`): `Promise`\<`void`\>
|
||||
|
||||
Defined in: [src/core/Session.ts:651](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L651)
|
||||
Defined in: [src/core/Session.ts:661](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L661)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -580,7 +568,7 @@ Defined in: [src/core/Session.ts:651](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> **signOut**(): `Promise`\<`Response` \| `undefined`\>
|
||||
|
||||
Defined in: [src/core/Session.ts:674](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L674)
|
||||
Defined in: [src/core/Session.ts:684](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L684)
|
||||
|
||||
Signs out of the current account and revokes the credentials.
|
||||
|
||||
@@ -592,13 +580,13 @@ Signs out of the current account and revokes the credentials.
|
||||
|
||||
### create()
|
||||
|
||||
> `static` **create**(`options`): `Promise`\<`Session`\>
|
||||
> `static` **create**(`options?`): `Promise`\<`Session`\>
|
||||
|
||||
Defined in: [src/core/Session.ts:295](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L295)
|
||||
Defined in: [src/core/Session.ts:301](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L301)
|
||||
|
||||
#### Parameters
|
||||
|
||||
##### options
|
||||
##### options?
|
||||
|
||||
[`SessionOptions`](../type-aliases/SessionOptions.md) = `{}`
|
||||
|
||||
@@ -612,7 +600,7 @@ Defined in: [src/core/Session.ts:295](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> `static` **fromCache**(`cache`, `session_args`): `Promise`\<[`SessionData`](../type-aliases/SessionData.md) \| `null`\>
|
||||
|
||||
Defined in: [src/core/Session.ts:327](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L327)
|
||||
Defined in: [src/core/Session.ts:334](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L334)
|
||||
|
||||
Retrieves session data from cache.
|
||||
|
||||
@@ -638,53 +626,57 @@ User provided session arguments.
|
||||
|
||||
### getSessionData()
|
||||
|
||||
> `static` **getSessionData**(`lang`, `location`, `account_index`, `visitor_data`, `user_agent`, `enable_safety_mode`, `generate_session_locally`, `device_category`, `client_name`, `tz`, `fetch`, `on_behalf_of_user?`, `cache?`, `enable_session_cache?`, `po_token?`, `retrieve_innertube_config?`): `Promise`\<\{ `account_index`: `number`; `api_key`: `string`; `api_version`: `string`; `config_data?`: `string`; `context`: [`Context`](../type-aliases/Context.md); \}\>
|
||||
> `static` **getSessionData**(`lang?`, `location?`, `account_index?`, `visitor_data?`, `user_agent?`, `enable_safety_mode?`, `generate_session_locally?`, `fail_fast?`, `device_category?`, `client_name?`, `tz?`, `fetch?`, `on_behalf_of_user?`, `cache?`, `enable_session_cache?`, `po_token?`, `retrieve_innertube_config?`): `Promise`\<\{ `account_index`: `number`; `api_key`: `string`; `api_version`: `string`; `config_data?`: `string`; `context`: [`Context`](../type-aliases/Context.md); \}\>
|
||||
|
||||
Defined in: [src/core/Session.ts:376](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/Session.ts#L376)
|
||||
Defined in: [src/core/Session.ts:383](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/Session.ts#L383)
|
||||
|
||||
#### Parameters
|
||||
|
||||
##### lang
|
||||
##### lang?
|
||||
|
||||
`string` = `''`
|
||||
|
||||
##### location
|
||||
##### location?
|
||||
|
||||
`string` = `''`
|
||||
|
||||
##### account\_index
|
||||
##### account\_index?
|
||||
|
||||
`number` = `0`
|
||||
|
||||
##### visitor\_data
|
||||
##### visitor\_data?
|
||||
|
||||
`string` = `''`
|
||||
|
||||
##### user\_agent
|
||||
##### user\_agent?
|
||||
|
||||
`string` = `...`
|
||||
|
||||
##### enable\_safety\_mode
|
||||
##### enable\_safety\_mode?
|
||||
|
||||
`boolean` = `false`
|
||||
|
||||
##### generate\_session\_locally
|
||||
##### generate\_session\_locally?
|
||||
|
||||
`boolean` = `false`
|
||||
|
||||
##### device\_category
|
||||
##### fail\_fast?
|
||||
|
||||
`boolean` = `false`
|
||||
|
||||
##### device\_category?
|
||||
|
||||
[`DeviceCategory`](../youtubei.js/namespaces/Utils/type-aliases/DeviceCategory.md) = `'desktop'`
|
||||
|
||||
##### client\_name
|
||||
##### client\_name?
|
||||
|
||||
[`ClientType`](../enumerations/ClientType.md) = `ClientType.WEB`
|
||||
|
||||
##### tz
|
||||
##### tz?
|
||||
|
||||
`string` = `...`
|
||||
|
||||
##### fetch
|
||||
##### fetch?
|
||||
|
||||
\{(`input`, `init?`): `Promise`\<`Response`\>; (`input`, `init?`): `Promise`\<`Response`\>; \}
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: ShowMiniplayerCommand
|
||||
|
||||
Defined in: [src/parser/continuations.ts:35](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L35)
|
||||
Defined in: [src/parser/continuations.ts:35](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L35)
|
||||
|
||||
## Extends
|
||||
|
||||
@@ -14,7 +14,7 @@ Defined in: [src/parser/continuations.ts:35](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **new ShowMiniplayerCommand**(`data`): `ShowMiniplayerCommand`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:41](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L41)
|
||||
Defined in: [src/parser/continuations.ts:41](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L41)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -36,7 +36,7 @@ Defined in: [src/parser/continuations.ts:41](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **miniplayer\_command**: [`NavigationEndpoint`](../youtubei.js/namespaces/YTNodes/classes/NavigationEndpoint.md)
|
||||
|
||||
Defined in: [src/parser/continuations.ts:38](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L38)
|
||||
Defined in: [src/parser/continuations.ts:38](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L38)
|
||||
|
||||
***
|
||||
|
||||
@@ -44,7 +44,7 @@ Defined in: [src/parser/continuations.ts:38](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **show\_premium\_branding**: `boolean`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:39](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L39)
|
||||
Defined in: [src/parser/continuations.ts:39](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L39)
|
||||
|
||||
***
|
||||
|
||||
@@ -52,7 +52,7 @@ Defined in: [src/parser/continuations.ts:39](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> `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
|
||||
|
||||
@@ -64,7 +64,7 @@ Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> `readonly` `static` **type**: `"showMiniplayerCommand"` = `'showMiniplayerCommand'`
|
||||
|
||||
Defined in: [src/parser/continuations.ts:36](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/continuations.ts#L36)
|
||||
Defined in: [src/parser/continuations.ts:36](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/continuations.ts#L36)
|
||||
|
||||
#### Overrides
|
||||
|
||||
@@ -76,7 +76,7 @@ Defined in: [src/parser/continuations.ts:36](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **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.
|
||||
|
||||
@@ -118,7 +118,7 @@ If the node is not of the given type
|
||||
|
||||
> **hasKey**\<`T`, `R`\>(`key`): `this is ShowMiniplayerCommand & { [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.
|
||||
|
||||
@@ -156,7 +156,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.
|
||||
|
||||
@@ -194,7 +194,7 @@ whether the node is of the given type
|
||||
|
||||
> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/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.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: UniversalCache
|
||||
|
||||
Defined in: [src/utils/Cache.ts:4](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/utils/Cache.ts#L4)
|
||||
Defined in: [src/utils/Cache.ts:4](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/utils/Cache.ts#L4)
|
||||
|
||||
## Implements
|
||||
|
||||
@@ -14,7 +14,7 @@ Defined in: [src/utils/Cache.ts:4](https://github.com/LuanRT/YouTube.js/blob/073
|
||||
|
||||
> **new UniversalCache**(`persistent`, `persistent_directory?`): `UniversalCache`
|
||||
|
||||
Defined in: [src/utils/Cache.ts:6](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/utils/Cache.ts#L6)
|
||||
Defined in: [src/utils/Cache.ts:6](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/utils/Cache.ts#L6)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -38,7 +38,7 @@ Defined in: [src/utils/Cache.ts:6](https://github.com/LuanRT/YouTube.js/blob/073
|
||||
|
||||
> **get** **cache\_dir**(): `string`
|
||||
|
||||
Defined in: [src/utils/Cache.ts:9](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/utils/Cache.ts#L9)
|
||||
Defined in: [src/utils/Cache.ts:9](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/utils/Cache.ts#L9)
|
||||
|
||||
##### Returns
|
||||
|
||||
@@ -54,7 +54,7 @@ Defined in: [src/utils/Cache.ts:9](https://github.com/LuanRT/YouTube.js/blob/073
|
||||
|
||||
> **get**(`key`): `Promise`\<`ArrayBuffer` \| `undefined`\>
|
||||
|
||||
Defined in: [src/utils/Cache.ts:12](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/utils/Cache.ts#L12)
|
||||
Defined in: [src/utils/Cache.ts:12](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/utils/Cache.ts#L12)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -76,7 +76,7 @@ Defined in: [src/utils/Cache.ts:12](https://github.com/LuanRT/YouTube.js/blob/07
|
||||
|
||||
> **remove**(`key`): `Promise`\<`void`\>
|
||||
|
||||
Defined in: [src/utils/Cache.ts:18](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/utils/Cache.ts#L18)
|
||||
Defined in: [src/utils/Cache.ts:18](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/utils/Cache.ts#L18)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -98,7 +98,7 @@ Defined in: [src/utils/Cache.ts:18](https://github.com/LuanRT/YouTube.js/blob/07
|
||||
|
||||
> **set**(`key`, `value`): `Promise`\<`void`\>
|
||||
|
||||
Defined in: [src/utils/Cache.ts:15](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/utils/Cache.ts#L15)
|
||||
Defined in: [src/utils/Cache.ts:15](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/utils/Cache.ts#L15)
|
||||
|
||||
#### Parameters
|
||||
|
||||
|
||||
Reference in New Issue
Block a user