Interface EitherError<E>

Base interface for CheckedError instances, providing methods to inspect and handle the contained error.

interface EitherError<E> {
    cause?: unknown;
    message: string;
    name: string;
    stack?: string;
    handle<T>(f: (e: ResultError) => T, g: (e: E) => T): T;
    isExpected(): this is ExpectedError<E>;
    isUnexpected(): this is UnexpectedError<E>;
}

Type Parameters

E

Hierarchy

Error
- EitherError

Index

Properties

cause? message name stack?

Methods

handle isExpected isUnexpected

Properties

`Optional`cause

cause?: unknown

message

message: string

name

name: string

`Optional`stack

stack?: string

Methods

handle

handle<T>(f: (e: ResultError) => T, g: (e: E) => T): T
Applies one of two functions to the contained error based on its type.

Applies the first function in case the inner error is unexpected ResultError, or the second function if the inner error is expected E.
Type Parameters
- T
Parameters
- f: (e: ResultError) => T
- g: (e: E) => T
Returns T
- Defined in packages/std/src/result/interface.ts:92

isExpected

isExpected(): this is ExpectedError<E>
Checks if this is an expected error, narrowing to ExpectedError.

Returns this is ExpectedError<E>
- Defined in packages/std/src/result/interface.ts:97

isUnexpected

isUnexpected(): this is UnexpectedError<E>
Checks if this is an unexpected error, narrowing to UnexpectedError.

Returns this is UnexpectedError<E>
- Defined in packages/std/src/result/interface.ts:102