chore: add proper documentation (#763)

* 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

View File

@@ -0,0 +1,199 @@
[youtubei.js](../../../README.md) / [Utils](../README.md) / ParsingError
# Class: ParsingError
## Extends
- [`InnertubeError`](InnertubeError.md)
## Constructors
### new ParsingError()
> **new ParsingError**(`message`, `info`?): [`ParsingError`](ParsingError.md)
#### Parameters
**message**: `string`
**info?**: `any`
#### Returns
[`ParsingError`](ParsingError.md)
#### Inherited from
[`InnertubeError`](InnertubeError.md).[`constructor`](InnertubeError.md#constructors)
#### Defined in
[src/utils/Utils.ts:30](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/utils/Utils.ts#L30)
## Properties
### cause?
> `optional` **cause**: `unknown`
#### Inherited from
[`InnertubeError`](InnertubeError.md).[`cause`](InnertubeError.md#cause)
#### Defined in
node\_modules/typescript/lib/lib.es2022.error.d.ts:24
***
### date
> **date**: `Date`
#### Inherited from
[`InnertubeError`](InnertubeError.md).[`date`](InnertubeError.md#date)
#### Defined in
[src/utils/Utils.ts:26](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/utils/Utils.ts#L26)
***
### info?
> `optional` **info**: `any`
#### Inherited from
[`InnertubeError`](InnertubeError.md).[`info`](InnertubeError.md#info)
#### Defined in
[src/utils/Utils.ts:28](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/utils/Utils.ts#L28)
***
### message
> **message**: `string`
#### Inherited from
[`InnertubeError`](InnertubeError.md).[`message`](InnertubeError.md#message)
#### Defined in
node\_modules/typescript/lib/lib.es5.d.ts:1077
***
### name
> **name**: `string`
#### Inherited from
[`InnertubeError`](InnertubeError.md).[`name`](InnertubeError.md#name)
#### Defined in
node\_modules/typescript/lib/lib.es5.d.ts:1076
***
### stack?
> `optional` **stack**: `string`
#### Inherited from
[`InnertubeError`](InnertubeError.md).[`stack`](InnertubeError.md#stack)
#### Defined in
node\_modules/typescript/lib/lib.es5.d.ts:1078
***
### version
> **version**: `string`
#### Inherited from
[`InnertubeError`](InnertubeError.md).[`version`](InnertubeError.md#version)
#### Defined in
[src/utils/Utils.ts:27](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/utils/Utils.ts#L27)
***
### prepareStackTrace()?
> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
Optional override for formatting stack traces
#### Parameters
**err**: `Error`
**stackTraces**: `CallSite`[]
#### Returns
`any`
#### See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
#### Inherited from
[`InnertubeError`](InnertubeError.md).[`prepareStackTrace`](InnertubeError.md#preparestacktrace)
#### Defined in
node\_modules/@types/node/globals.d.ts:11
***
### stackTraceLimit
> `static` **stackTraceLimit**: `number`
#### Inherited from
[`InnertubeError`](InnertubeError.md).[`stackTraceLimit`](InnertubeError.md#stacktracelimit)
#### Defined in
node\_modules/@types/node/globals.d.ts:13
## Methods
### captureStackTrace()
> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
Create .stack property on a target object
#### Parameters
**targetObject**: `object`
**constructorOpt?**: `Function`
#### Returns
`void`
#### Inherited from
[`InnertubeError`](InnertubeError.md).[`captureStackTrace`](InnertubeError.md#capturestacktrace)
#### Defined in
node\_modules/@types/node/globals.d.ts:4