Class Cancellation

If canceled, a [[CancellablePromise]] should throw an Cancellation object.

Hierarchy

Error
- Cancellation

Index

Constructors

Properties

message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

new Cancellation(message?: string): Cancellation
Parameters
- message: string = 'Promise canceled.'
Returns Cancellation
Overrides Error.constructor
- Defined in src/Cancellation.ts:5

Properties

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

Generated using TypeDoc