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,177 @@
[youtubei.js](../../../README.md) / [Utils](../README.md) / SessionError
# Class: SessionError
## Extends
- `Error`
## Constructors
### new SessionError()
> **new SessionError**(`message`?): [`SessionError`](SessionError.md)
#### Parameters
**message?**: `string`
#### Returns
[`SessionError`](SessionError.md)
#### Inherited from
`Error.constructor`
#### Defined in
node\_modules/typescript/lib/lib.es5.d.ts:1082
### new SessionError()
> **new SessionError**(`message`?, `options`?): [`SessionError`](SessionError.md)
#### Parameters
**message?**: `string`
**options?**: `ErrorOptions`
#### Returns
[`SessionError`](SessionError.md)
#### Inherited from
`Error.constructor`
#### Defined in
node\_modules/typescript/lib/lib.es5.d.ts:1082
## Properties
### cause?
> `optional` **cause**: `unknown`
#### Inherited from
`Error.cause`
#### Defined in
node\_modules/typescript/lib/lib.es2022.error.d.ts:24
***
### 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
***
### 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