jirayu_sri/YouTube.js
1
0
Fork 0
mirror of https://github.com/LuanRT/YouTube.js.git synced 2026-06-27 16:48:55 +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

97
docs/api/namespaces/Helpers/classes/SuperParsedResult.md Normal file
View File

@@ -0,0 +1,97 @@
[youtubei.js](../../../README.md) / [Helpers](../README.md) / SuperParsedResult
# Class: SuperParsedResult\<T\>
Represents a parsed response in an unknown state. Either a YTNode or a YTNode[] or null.
## Type Parameters
• **T** *extends* [`YTNode`](YTNode.md) = [`YTNode`](YTNode.md)
## Constructors
### new SuperParsedResult()
> **new SuperParsedResult**\<`T`\>(`result`): [`SuperParsedResult`](SuperParsedResult.md)\<`T`\>
#### Parameters
• **result**: `null` \| `T` \| [`ObservedArray`](../type-aliases/ObservedArray.md)\<`T`\>
#### Returns
[`SuperParsedResult`](SuperParsedResult.md)\<`T`\>
#### Defined in
[src/parser/helpers.ts:326](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L326)
## Accessors
### is\_array
> `get` **is\_array**(): `boolean`
#### Returns
`boolean`
#### Defined in
[src/parser/helpers.ts:333](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L333)
***
### is\_node
> `get` **is\_node**(): `boolean`
#### Returns
`boolean`
#### Defined in
[src/parser/helpers.ts:336](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L336)
***
### is\_null
> `get` **is\_null**(): `boolean`
#### Returns
`boolean`
#### Defined in
[src/parser/helpers.ts:330](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L330)
## Methods
### array()
> **array**(): [`ObservedArray`](../type-aliases/ObservedArray.md)\<`T`\>
#### Returns
[`ObservedArray`](../type-aliases/ObservedArray.md)\<`T`\>
#### Defined in
[src/parser/helpers.ts:340](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L340)
***
### item()
> **item**(): `T`
#### Returns
`T`
#### Defined in
[src/parser/helpers.ts:347](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L347)