mirror of
https://github.com/LuanRT/YouTube.js.git
synced 2026-06-16 11:02:10 +00:00
74659fd03f
* chore: generate API ref using `typedoc` * chore: declutter readme and add links to ytjs.dev * chore: clean up
72 lines
1.8 KiB
Markdown
72 lines
1.8 KiB
Markdown
[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)
|