Class CommandError

Hierarchy (view full)

CommandHandlerError
- CommandError

Index

Constructors

Properties

prepareStackTrace? stackTraceLimit cause? data date message name stack? type where

Methods

captureStackTrace

Constructors

constructor

new CommandError(options): CommandError
Creates a new CommandError.
Parameters
- options: CommandErrorBuilder
  The options of the error, containing type and raw data.
Returns CommandError
See
- CommandErrorType to see what those errors are related to.
- Command#validate to see when those errors can occur.
Overrides CommandHandlerError.constructor
- Defined in source/src/classes/errors/CommandError.ts:53

Properties

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

- (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

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

`Static` stackTraceLimit

stackTraceLimit: number

`Optional` cause

cause?: unknown

`Readonly` data

data: any

The data of the error, can be anything but should be related to the error type.

See

CommandErrorBuilder#type.

`Readonly` date

date: Date

When the error occurred.

message

message: string

name

name: string

`Optional` stack

stack?: string

`Readonly` type

type: CommandErrorType

The type of CommandError.

`Readonly` where

where: string

Where the error occurred.

Methods

`Static` captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void
Inherited from CommandHandlerError.captureStackTrace
- Defined in source/node_modules/@types/node/globals.d.ts:21

Generated using TypeDoc