Birb / BirbAPIError
Class: BirbAPIError
Hierarchy
-
↳
BirbAPIError
Table of contents
Constructors
Properties
- body
- cause
- endpoint
- headers
- json
- message
- name
- package
- stack
- status
- prepareStackTrace
- stackTraceLimit
Methods
Constructors
constructor
• new BirbAPIError(message, request, status, json?)
Parameters
| Name | Type |
|---|---|
message | string |
request | APIEndpoint<any, any, any> |
status | number |
json? | any |
Overrides
Defined in
src/classes/errors/BirbAPIError.ts:11
Properties
body
• Readonly body: any
Defined in
src/classes/errors/BirbAPIError.ts:8
cause
• Optional cause: unknown
Inherited from
Defined in
node_modules/typescript/lib/lib.es2022.error.d.ts:26
endpoint
• Readonly endpoint: string
Defined in
src/classes/errors/BirbAPIError.ts:6
headers
• Readonly headers: Object
Index signature
▪ [key: string]: string
Defined in
src/classes/errors/BirbAPIError.ts:7
json
• Readonly json: any
Defined in
src/classes/errors/BirbAPIError.ts:9
message
• message: string
Inherited from
Defined in
node_modules/typescript/lib/lib.es5.d.ts:1041
name
• name: string
Inherited from
Defined in
node_modules/typescript/lib/lib.es5.d.ts:1040
package
• Readonly package: "birb"
Inherited from
Defined in
src/classes/errors/BirbError.ts:2
stack
• Optional stack: string
Inherited from
Defined in
node_modules/typescript/lib/lib.es5.d.ts:1042
status
• Readonly status: number
Defined in
src/classes/errors/BirbAPIError.ts:5
prepareStackTrace
▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any
Type declaration
▸ (err, stackTraces): any
Optional override for formatting stack traces
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
| Name | Type |
|---|---|
err | Error |
stackTraces | CallSite[] |
Returns
any
Inherited from
Defined in
node_modules/@types/node/globals.d.ts:11
stackTraceLimit
▪ Static stackTraceLimit: number
Inherited from
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
| Name | Type |
|---|---|
targetObject | object |
constructorOpt? | Function |
Returns
void
Inherited from
Defined in
node_modules/@types/node/globals.d.ts:4