jirayu_sri/YouTube.js
1
0
Fork 0
mirror of https://github.com/LuanRT/YouTube.js.git synced 2026-06-19 04:21:35 +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

71
docs/api/namespaces/Parser/functions/parseItem.md Normal file
View File

@@ -0,0 +1,71 @@
[youtubei.js](../../../README.md) / [Parser](../README.md) / parseItem
# Function: parseItem()
## parseItem(data, validTypes)
> **parseItem**\<`T`, `K`\>(`data`, `validTypes`): `InstanceType`\<`K`\[`number`\]\> \| `null`
Parses a single item.
### Type Parameters
• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md)
• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[]
### Parameters
• **data**: `undefined` \| [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)
The data to parse.
• **validTypes**: `K`
YTNode types that are allowed to be parsed.
### Returns
`InstanceType`\<`K`\[`number`\]\> \| `null`
### Defined in
[src/parser/parser.ts:511](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/parser.ts#L511)
## parseItem(data, validTypes)
> **parseItem**\<`T`\>(`data`, `validTypes`): `T` \| `null`
### Type Parameters
• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md)
### Parameters
• **data**: `undefined` \| [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)
• **validTypes**: [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>
### Returns
`T` \| `null`
### Defined in
[src/parser/parser.ts:512](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/parser.ts#L512)
## parseItem(data)
> **parseItem**(`data`?): [`YTNode`](../../Helpers/classes/YTNode.md)
### Parameters
• **data?**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)
### Returns
[`YTNode`](../../Helpers/classes/YTNode.md)
### Defined in
[src/parser/parser.ts:513](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/parser.ts#L513)