Class CommandError

Error class to be used when the command throws an error.

Hierarchy

Error
- CommandError

Index

Constructors

Properties

cmd code message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

new CommandError(message: string, cmd: string): CommandError
Parameters
- message: string
- cmd: string
Returns CommandError
Overrides Error.constructor
- Defined in src/common/errors/command.ts:12

Properties

cmd

cmd: string

Command line that triggered the command error.

code

code: string = 'ERR_COMMAND_ERRORED'

Code to identify the error in catch clauses.

message

message: string

name

name: string

`Optional` stack

stack?: string

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Type declaration

- (err: Error, stackTraces: CallSite[]): 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

`Static` stackTraceLimit

stackTraceLimit: number

Methods

`Static` captureStackTrace

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

Generated using TypeDoc