Class WorkDoneError<TWork>

An error indicating the work is already done.

Type Parameters

TWork = unknown

Hierarchy

TypeError
- WorkDoneError

Index

Constructors

Properties

message name reason stack? work workload prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

new WorkDoneError<TWork>(workload, work, reason, message?): WorkDoneError<TWork>
Constructs a work done error.
Type Parameters
- TWork = unknown
Parameters
- workload: Workload<TWork>
  
  A workload the work is done for.
- work: undefined | TWork
  
  The work already done, if any.
- reason: unknown
  
  The reason of work failure, or undefined if the work completed successfully.
- message: string = ...
  
  Custom error message.
Returns WorkDoneError<TWork>
Overrides TypeError.constructor
- Defined in proc7ts/workbench/src/work-done-error.ts:16

Properties

message

message: string

name

name: string

`Readonly` reason

reason: unknown

The reason of work failure, or undefined if the work completed successfully.

`Optional` stack

stack?: string

`Readonly` work

work: undefined | TWork

The work already done, if any.

`Readonly` workload

workload: Workload<TWork>

A workload the work is done for.

`Static` `Optional` prepareStackTrace

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

Type declaration

- (err, stackTraces): any
- Optional override for formatting stack traces
  
  See
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any

`Static` stackTraceLimit

stackTraceLimit: number

Methods

`Static` captureStackTrace

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

Generated using TypeDoc