Class Err<E>

Extends the built-in Error class with a label and an optional source.

Type Parameters

E extends string = string
The type of the error label, constrained to string

Hierarchy

Error
- Err

Index

Constructors

Methods

captureStackTrace from resultFrom

Properties

cause? label message name source? stack? prepareStackTrace? stackTraceLimit

Constructors

constructor

new Err<E extends string = string>(
    label: E,
    message?: string,
    source?: unknown,
): Err<E>
Type Parameters
- E extends string = string
Parameters
- label: E
- Optionalmessage: string
- Optionalsource: unknown
Returns Err<E>
Overrides Error.constructor
- Defined in src/lib/result.ts:15

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

`Static`from

from<E extends string = string>(source: unknown, label: E): Err<E>
Creates an Err instance from an unknown value.
Type Parameters
- E extends string = string
Parameters
- source: unknown
  The error value to convert
- label: E
  The label to identify the error type
Returns Err<E>
An Err instance
Example
```
const error = new Error("The requested resource was not found");
const err = Err.from(error, "NOT_FOUND");
```
- Defined in src/lib/result.ts:46

`Static`resultFrom

resultFrom<E extends string = string>(source: unknown, label: E): ResultErr<E>
Creates a ResultErr from an unknown value.
Type Parameters
- E extends string = string
Parameters
- source: unknown
  The error value to convert
- label: E
  The label to identify the error type
Returns ResultErr<E>
A ResultErr
Example
```
const error = new Error("The requested resource was not found");
const result = Err.resultFrom(error, "NOT_FOUND");
// result: [Err<"NOT_FOUND">, null]
```
- Defined in src/lib/result.ts:77

Properties

`Optional`cause

cause?: unknown

label

label: E

The label identifying the type of error.

message

message: string

name

name: string

`Optional`source

source?: unknown

The source of the error, if applicable.

`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