Class BaseException<TParams, TOptions>`Abstract`

Type Parameters

TParams extends ExceptionParams
TOptions extends ExceptionOptions

Hierarchy

Error
- BaseException

Implements

ExceptionLike

Index

Constructors

Properties

cause details message name stack? prepareStackTrace? stackTraceLimit

Methods

toAsyncErr toErr toString captureStackTrace isError

Constructors

constructor

new BaseException<
    TParams extends ExceptionParams<any>,
    TOptions extends ExceptionOptions,
>(
    message?: string,
    options?: TOptions,
): BaseException<TParams, TOptions>
Type Parameters
- TParams extends ExceptionParams<any>
- TOptions extends ExceptionOptions
Parameters
- Optionalmessage: string
- Optionaloptions: TOptions
Returns BaseException<TParams, TOptions>
Overrides Error.constructor
- Defined in src/exception.ts:125

Properties

cause

cause: TOptions["cause"]

details

details: TOptions["details"]

message

message: string

`Abstract`name

name: TParams["name"]

`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

toAsyncErr

toAsyncErr(): ResultAsync<never, BaseException<TParams, TOptions>>
Returns ResultAsync<never, BaseException<TParams, TOptions>>
Implementation of ExceptionLike.toAsyncErr
- Defined in src/exception.ts:131

toErr

toErr(): Result<never, BaseException<TParams, TOptions>>
Returns Result<never, BaseException<TParams, TOptions>>
Implementation of ExceptionLike.toErr
- Defined in src/exception.ts:135

toString

toString(): string
Returns a string representation of an object.

Returns string
Implementation of ExceptionLike.toString
- Defined in src/exception.ts:139

`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/.pnpm/@types+node@22.13.2/node_modules/@types/node/globals.d.ts:136

`Static`isError

isError(error: unknown): error is Error
Indicates whether the argument provided is a built-in Error instance or not.
Parameters
- error: unknown
Returns error is Error
Inherited from Error.isError
- Defined in node_modules/.pnpm/typescript@6.0.2/node_modules/typescript/lib/lib.esnext.error.d.ts:21