Class ZOptionError

An error thrown by command line options parser when it encounters unrecognized or malformed option.

Hierarchy

Error
- ZOptionError

Index

Constructors

Properties

prepareStackTrace? stackTraceLimit cause? message name stack? #optionLocation

Accessors

Methods

captureStackTrace

Constructors

constructor

new ZOptionError(optionLocation, message?): ZOptionError
Constructs option error.
Parameters
- optionLocation: ZOptionLocation
  
  Erroneous option location.
- message: string = ...
  
  Error message.
Returns ZOptionError
Overrides Error.constructor
- Defined in run-z/optionz/src/option-error.ts:17

Properties

`Static` `Optional` prepareStackTrace

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

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

`Static` stackTraceLimit

stackTraceLimit: number

`Optional` cause

cause?: unknown

message

message: string

name

name: string

`Optional` stack

stack?: string

`Private` `Readonly` #optionLocation

#optionLocation: Required<ZOptionLocation>

Accessors

optionLocation

get optionLocation(): Required<ZOptionLocation>
Erroneous option location.

Returns Required<ZOptionLocation>
- Defined in run-z/optionz/src/option-error.ts:26

Methods

`Static` captureStackTrace

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

Generated using TypeDoc