Interface ErrResult<E>

Failed result carrying error.

interface ErrResult<E> {
    error: E;
    isErr: true;
    isOk: false;
    andThen<U, F>(_fn: (value: never) => Result<U, F>): ErrResult<E>;
    map<U>(_fn: (value: never) => U): ErrResult<E>;
    mapErr<F>(fn: (error: E) => F): ErrResult<F>;
    match<U>(_onOk: (value: never) => U, onErr: (error: E) => U): U;
    unwrapOr<T>(fallback: T): T;
}

Type Parameters

E

Index

Properties

error isErr isOk

Methods

andThen map mapErr match unwrapOr

Properties

`Readonly`error

error: E

The error value.

`Readonly`isErr

isErr: true

Always true — use this to narrow the union to ErrResult<E>.

`Readonly`isOk

isOk: false

Always false — use this to narrow the union to ErrResult<E>.

Methods

andThen

andThen<U, F>(_fn: (value: never) => Result<U, F>): ErrResult<E>
Returns this unchanged.
Type Parameters
- U
- F
Parameters
- _fn: (value: never) => Result<U, F>
Returns ErrResult<E>
- Defined in packages/core/src/result.ts:58

map

map<U>(_fn: (value: never) => U): ErrResult<E>
Returns this unchanged.
Type Parameters
- U
Parameters
- _fn: (value: never) => U
Returns ErrResult<E>
- Defined in packages/core/src/result.ts:54

mapErr

mapErr<F>(fn: (error: E) => F): ErrResult<F>
Returns an ErrResult with fn(error).
Type Parameters
- F
Parameters
- fn: (error: E) => F
Returns ErrResult<F>
- Defined in packages/core/src/result.ts:56

match

match<U>(_onOk: (value: never) => U, onErr: (error: E) => U): U
Calls onErr and returns its result.
Type Parameters
- U
Parameters
- _onOk: (value: never) => U
- onErr: (error: E) => U
Returns U
- Defined in packages/core/src/result.ts:60

unwrapOr

unwrapOr<T>(fallback: T): T
Returns fallback.
Type Parameters
- T
Parameters
- fallback: T
Returns T
- Defined in packages/core/src/result.ts:62