jirayu_sri/YouTube.js
1
0
Fork 0
mirror of https://github.com/LuanRT/YouTube.js.git synced 2026-06-25 15:52:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: add proper documentation (#763)

Browse Source 
* chore: generate API ref using `typedoc`

* chore: declutter readme and add links to ytjs.dev

* chore: clean up
This commit is contained in:
Luan
2024-09-23 17:32:50 -03:00
committed by GitHub
parent dd7f5cf778
commit 74659fd03f
853 changed files with 139814 additions and 1929 deletions
Download Patch File Download Diff File Expand all files Collapse all files

153
docs/api/namespaces/YT/classes/SmoothedQueue.md Normal file
View File

@@ -0,0 +1,153 @@
[youtubei.js](../../../README.md) / [YT](../README.md) / SmoothedQueue
# Class: SmoothedQueue
## Constructors
### new SmoothedQueue()
> **new SmoothedQueue**(): [`SmoothedQueue`](SmoothedQueue.md)
#### Returns
[`SmoothedQueue`](SmoothedQueue.md)
#### Defined in
[src/parser/youtube/SmoothedQueue.ts:54](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/SmoothedQueue.ts#L54)
## Accessors
### action\_queue
> `get` **action\_queue**(): [`YTNode`](../../Helpers/classes/YTNode.md)[][]
#### Returns
[`YTNode`](../../Helpers/classes/YTNode.md)[][]
#### Defined in
[src/parser/youtube/SmoothedQueue.ts:140](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/SmoothedQueue.ts#L140)
***
### callback
> `get` **callback**(): `null` \| (`actions`) => `void`
> `set` **callback**(`cb`): `void`
#### Parameters
• **cb**: `null` \| (`actions`) => `void`
#### Returns
`null` \| (`actions`) => `void`
#### Defined in
[src/parser/youtube/SmoothedQueue.ts:136](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/SmoothedQueue.ts#L136)
***
### estimated\_update\_interval
> `get` **estimated\_update\_interval**(): `null` \| `number`
#### Returns
`null` \| `number`
#### Defined in
[src/parser/youtube/SmoothedQueue.ts:144](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/SmoothedQueue.ts#L144)
***
### last\_update\_time
> `get` **last\_update\_time**(): `null` \| `number`
#### Returns
`null` \| `number`
#### Defined in
[src/parser/youtube/SmoothedQueue.ts:148](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/SmoothedQueue.ts#L148)
***
### next\_update\_id
> `get` **next\_update\_id**(): `any`
#### Returns
`any`
#### Defined in
[src/parser/youtube/SmoothedQueue.ts:152](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/SmoothedQueue.ts#L152)
***
### poll\_response\_delay\_queue
> `get` **poll\_response\_delay\_queue**(): `DelayQueue`
#### Returns
`DelayQueue`
#### Defined in
[src/parser/youtube/SmoothedQueue.ts:156](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/SmoothedQueue.ts#L156)
## Methods
### clear()
> **clear**(): `void`
#### Returns
`void`
#### Defined in
[src/parser/youtube/SmoothedQueue.ts:124](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/SmoothedQueue.ts#L124)
***
### emitSmoothedActions()
> **emitSmoothedActions**(): `void`
#### Returns
`void`
#### Defined in
[src/parser/youtube/SmoothedQueue.ts:91](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/SmoothedQueue.ts#L91)
***
### enqueueActionGroup()
> **enqueueActionGroup**(`group`): `void`
#### Parameters
• **group**: [`YTNode`](../../Helpers/classes/YTNode.md)[]
#### Returns
`void`
#### Defined in
[src/parser/youtube/SmoothedQueue.ts:63](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/SmoothedQueue.ts#L63)