mirror of
https://github.com/simplex-chat/simplex-chat.git
synced 2026-04-27 19:26:12 +00:00
sh
42dd36bf09
* simplex-chat-nodejs: typed DbConfig for ChatApi.init and BotDbOpts * simplex-chat-nodejs: regenerate typedoc docs for DbConfig * simplex-chat-nodejs: rename DbConfig.kind to .type
206 lines
3.6 KiB
Markdown
206 lines
3.6 KiB
Markdown
[**simplex-chat**](README.md)
|
|
|
|
***
|
|
|
|
[simplex-chat](README.md) / [api](Namespace.api.md) / ChatCommandError
|
|
|
|
# Class: ChatCommandError
|
|
|
|
Defined in: [src/api.ts:5](../src/api.ts#L5)
|
|
|
|
## Extends
|
|
|
|
- `Error`
|
|
|
|
## Constructors
|
|
|
|
### Constructor
|
|
|
|
> **new ChatCommandError**(`message`, `response`): `ChatCommandError`
|
|
|
|
Defined in: [src/api.ts:6](../src/api.ts#L6)
|
|
|
|
#### Parameters
|
|
|
|
##### message
|
|
|
|
`string`
|
|
|
|
##### response
|
|
|
|
`ChatResponse`
|
|
|
|
#### Returns
|
|
|
|
`ChatCommandError`
|
|
|
|
#### Overrides
|
|
|
|
`Error.constructor`
|
|
|
|
## Properties
|
|
|
|
### message
|
|
|
|
> **message**: `string`
|
|
|
|
Defined in: [src/api.ts:6](../src/api.ts#L6)
|
|
|
|
#### Inherited from
|
|
|
|
`Error.message`
|
|
|
|
***
|
|
|
|
### name
|
|
|
|
> **name**: `string`
|
|
|
|
Defined in: [node\_modules/typescript/lib/lib.es5.d.ts:1076](../node_modules/typescript/lib/lib.es5.d.ts#L1076)
|
|
|
|
#### Inherited from
|
|
|
|
`Error.name`
|
|
|
|
***
|
|
|
|
### response
|
|
|
|
> **response**: `ChatResponse`
|
|
|
|
Defined in: [src/api.ts:6](../src/api.ts#L6)
|
|
|
|
***
|
|
|
|
### stack?
|
|
|
|
> `optional` **stack?**: `string`
|
|
|
|
Defined in: [node\_modules/typescript/lib/lib.es5.d.ts:1078](../node_modules/typescript/lib/lib.es5.d.ts#L1078)
|
|
|
|
#### Inherited from
|
|
|
|
`Error.stack`
|
|
|
|
***
|
|
|
|
### stackTraceLimit
|
|
|
|
> `static` **stackTraceLimit**: `number`
|
|
|
|
Defined in: [node\_modules/@types/node/globals.d.ts:67](../node_modules/@types/node/globals.d.ts#L67)
|
|
|
|
The `Error.stackTraceLimit` property specifies the number of stack frames
|
|
collected by a stack trace (whether generated by `new Error().stack` or
|
|
`Error.captureStackTrace(obj)`).
|
|
|
|
The default value is `10` but may be set to any valid JavaScript number. Changes
|
|
will affect any stack trace captured _after_ the value has been changed.
|
|
|
|
If set to a non-number value, or set to a negative number, stack traces will
|
|
not capture any frames.
|
|
|
|
#### Inherited from
|
|
|
|
`Error.stackTraceLimit`
|
|
|
|
## Methods
|
|
|
|
### captureStackTrace()
|
|
|
|
> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
|
|
|
|
Defined in: [node\_modules/@types/node/globals.d.ts:51](../node_modules/@types/node/globals.d.ts#L51)
|
|
|
|
Creates a `.stack` property on `targetObject`, which when accessed returns
|
|
a string representing the location in the code at which
|
|
`Error.captureStackTrace()` was called.
|
|
|
|
```js
|
|
const myObject = {};
|
|
Error.captureStackTrace(myObject);
|
|
myObject.stack; // Similar to `new Error().stack`
|
|
```
|
|
|
|
The first line of the trace will be prefixed with
|
|
`${myObject.name}: ${myObject.message}`.
|
|
|
|
The optional `constructorOpt` argument accepts a function. If given, all frames
|
|
above `constructorOpt`, including `constructorOpt`, will be omitted from the
|
|
generated stack trace.
|
|
|
|
The `constructorOpt` argument is useful for hiding implementation
|
|
details of error generation from the user. For instance:
|
|
|
|
```js
|
|
function a() {
|
|
b();
|
|
}
|
|
|
|
function b() {
|
|
c();
|
|
}
|
|
|
|
function c() {
|
|
// Create an error without stack trace to avoid calculating the stack trace twice.
|
|
const { stackTraceLimit } = Error;
|
|
Error.stackTraceLimit = 0;
|
|
const error = new Error();
|
|
Error.stackTraceLimit = stackTraceLimit;
|
|
|
|
// Capture the stack trace above function b
|
|
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
|
|
throw error;
|
|
}
|
|
|
|
a();
|
|
```
|
|
|
|
#### Parameters
|
|
|
|
##### targetObject
|
|
|
|
`object`
|
|
|
|
##### constructorOpt?
|
|
|
|
`Function`
|
|
|
|
#### Returns
|
|
|
|
`void`
|
|
|
|
#### Inherited from
|
|
|
|
`Error.captureStackTrace`
|
|
|
|
***
|
|
|
|
### prepareStackTrace()
|
|
|
|
> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`
|
|
|
|
Defined in: [node\_modules/@types/node/globals.d.ts:55](../node_modules/@types/node/globals.d.ts#L55)
|
|
|
|
#### Parameters
|
|
|
|
##### err
|
|
|
|
`Error`
|
|
|
|
##### stackTraces
|
|
|
|
`CallSite`[]
|
|
|
|
#### Returns
|
|
|
|
`any`
|
|
|
|
#### See
|
|
|
|
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
|
|
|
|
#### Inherited from
|
|
|
|
`Error.prepareStackTrace`
|