Class CustomError<C>

Description

The base error class for this library.

Remarks

Inspired by ZodError: https://zod.dev/ERROR_HANDLING?id=zoderror

Type Parameters

C extends string

Hierarchy (View Summary)

Error
- CustomError
  - TransactionError

Index

Constructors

Properties

code? issues message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

new CustomError<C extends string>(options: ErrorOptions<C>): CustomError<C>
Type Parameters
- C extends string
Parameters
- options: ErrorOptions<C>
  The ErrorOptions object containing the error message, issues, and code.
Returns CustomError<C>
Overrides Error.constructor
- Defined in src/errors/custom-error.ts:50

Properties

`Optional`code

code?: C

issues

issues: CustomIssue[]

message

message: string

name

name: string

`Optional`stack

stack?: string

`Static` `Optional`prepareStackTrace

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

Optional override for formatting stack traces

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
- OptionalconstructorOpt: Function
Returns void
Inherited from Error.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:136