Class WrapError

Hierarchy

Error
- WrapError

Index

Constructors

Properties

args? cause? code innerError? message method? name reason resolutionStack? source? stack? uri prepareStackTrace? re stackTraceLimit

Methods

toJSON toString _parse captureStackTrace parse sanitizeUnwrappedRustResult stringify stringifyCause

Constructors

constructor

new WrapError(reason?, options): WrapError
Parameters
- reason: string = "Encountered an exception."
- options: WrapErrorOptions
Returns WrapError
Overrides Error.constructor
- Defined in packages/core/src/types/WrapError.ts:68

Properties

`Optional` `Readonly` args

args?: string

`Optional` `Readonly` cause

cause?: unknown

`Readonly` code

code: WrapErrorCode

`Optional` `Readonly` innerError

innerError?: WrapError

message

message: string

`Optional` `Readonly` method

method?: string

`Readonly` name

name: string = "WrapError"

`Readonly` reason

reason: string

`Optional` `Readonly` resolutionStack

resolutionStack?: CleanResolutionStep

`Optional` `Readonly` source

source?: Readonly<{
    col?: number;
    file?: string;
    row?: number;
}>

Type declaration

Optional col?: number
Optional file?: string
Optional row?: number

`Optional` stack

stack?: string

`Readonly` uri

uri: string

`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

`Private` `Static` re

re: RegExp = ...

`Static` stackTraceLimit

stackTraceLimit: number

Methods

toJSON

toJSON(): string
Returns string
- Defined in packages/core/src/types/WrapError.ts:139

toString

toString(): string
Returns string
- Defined in packages/core/src/types/WrapError.ts:135

`Private` `Static` _parse

_parse(error): undefined | {
options: WrapErrorOptions;
reason: string;
}
Parameters
- error: string
Returns undefined | {
options: WrapErrorOptions;
reason: string;
}
- Defined in packages/core/src/types/WrapError.ts:157

`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/@types/node/globals.d.ts:4

`Static` parse

parse(error): undefined | WrapError
Parameters
- error: string
Returns undefined | WrapError
- Defined in packages/core/src/types/WrapError.ts:105

`Private` `Static` sanitizeUnwrappedRustResult

sanitizeUnwrappedRustResult(error): string
Parameters
- error: string
Returns string
- Defined in packages/core/src/types/WrapError.ts:144

`Private` `Static` stringify

stringify(reason, options): string
Parameters
- reason: string
- options: WrapErrorOptions
Returns string
- Defined in packages/core/src/types/WrapError.ts:216

`Private` `Static` stringifyCause

stringifyCause(cause): undefined | string
Parameters
- cause: unknown
Returns undefined | string
- Defined in packages/core/src/types/WrapError.ts:264

Generated using TypeDoc