Files
YouTube.js/docs/api/namespaces/Parser/functions/parse.md
Luan 74659fd03f chore: add proper documentation (#763)
* chore: generate API ref using `typedoc`

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

* chore: clean up
2024-09-23 17:32:50 -03:00

2.7 KiB

youtubei.js / Parser / parse

Function: parse()

parse(data, requireArray, validTypes)

parse<T, K>(data, requireArray, validTypes?): ObservedArray<InstanceType<K[number]>> | null

Parses an item or an array of items.

Type Parameters

T extends YTNode

K extends YTNodeConstructor<T>[]

Parameters

data: RawData

The data to parse.

requireArray: true

Whether the data should be parsed as an array.

validTypes?: K

YTNode types that are allowed to be parsed.

Returns

ObservedArray<InstanceType<K[number]>> | null

Defined in

src/parser/parser.ts:604

parse(data, requireArray, validTypes)

parse<T, K>(data, requireArray, validTypes?): ObservedArray<InstanceType<K>> | null

Type Parameters

T extends YTNode

K extends YTNodeConstructor<T>

Parameters

data: RawData

requireArray: true

validTypes?: K

Returns

ObservedArray<InstanceType<K>> | null

Defined in

src/parser/parser.ts:605

parse(data, requireArray, validTypes)

parse<T>(data?, requireArray?, validTypes?): SuperParsedResult<T>

Type Parameters

T extends YTNode = YTNode

Parameters

data?: RawData

requireArray?: false

validTypes?: YTNodeConstructor<T> | YTNodeConstructor<T>[]

Returns

SuperParsedResult<T>

Defined in

src/parser/parser.ts:606