chore: add proper documentation (#763)

* chore: generate API ref using `typedoc` * chore: declutter readme and add links to ytjs.dev * chore: clean up
2026-06-18 20:12:12 +00:00 · 2024-09-23 17:32:50 -03:00
parent dd7f5cf778
commit 74659fd03f
853 changed files with 139814 additions and 1929 deletions
--- a/docs/api/namespaces/Utils/classes/InnertubeError.md
+++ b/docs/api/namespaces/Utils/classes/InnertubeError.md
@@ -0,0 +1,193 @@
+[youtubei.js](../../../README.md) / [Utils](../README.md) / InnertubeError
+
+# Class: InnertubeError
+
+## Extends
+
+- `Error`
+
+## Extended by
+
+- [`ParsingError`](ParsingError.md)
+- [`MissingParamError`](MissingParamError.md)
+- [`OAuth2Error`](OAuth2Error.md)
+
+## Constructors
+
+### new InnertubeError()
+
+> **new InnertubeError**(`message`, `info`?): [`InnertubeError`](InnertubeError.md)
+
+#### Parameters
+
+• **message**: `string`
+
+• **info?**: `any`
+
+#### Returns
+
+[`InnertubeError`](InnertubeError.md)
+
+#### Overrides
+
+`Error.constructor`
+
+#### 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
+
+`Error.cause`
+
+#### Defined in
+
+node\_modules/typescript/lib/lib.es2022.error.d.ts:24
+
+***
+
+### date
+
+> **date**: `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`
+
+#### 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
+
+`Error.message`
+
+#### Defined in
+
+node\_modules/typescript/lib/lib.es5.d.ts:1077
+
+***
+
+### name
+
+> **name**: `string`
+
+#### Inherited from
+
+`Error.name`
+
+#### Defined in
+
+node\_modules/typescript/lib/lib.es5.d.ts:1076
+
+***
+
+### stack?
+
+> `optional` **stack**: `string`
+
+#### Inherited from
+
+`Error.stack`
+
+#### Defined in
+
+node\_modules/typescript/lib/lib.es5.d.ts:1078
+
+***
+
+### version
+
+> **version**: `string`
+
+#### 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
+
+`Error.prepareStackTrace`
+
+#### Defined in
+
+node\_modules/@types/node/globals.d.ts:11
+
+***
+
+### stackTraceLimit
+
+> `static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+`Error.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
+
+`Error.captureStackTrace`
+
+#### Defined in
+
+node\_modules/@types/node/globals.d.ts:4