Interface OkResult<T>

Successful result carrying value.

interface OkResult<T> {
    isErr: false;
    isOk: true;
    value: T;
    andThen<U, F>(fn: (value: T) => Result<U, F>): Result<U, F>;
    map<U>(fn: (value: T) => U): OkResult<U>;
    mapErr<F>(_fn: (error: never) => F): OkResult<T>;
    match<U>(onOk: (value: T) => U, _onErr: (error: never) => U): U;
    unwrapOr(_fallback: T): T;
}

Type Parameters

T

Index

Properties

isErr isOk value

Methods

andThen map mapErr match unwrapOr

Properties

`Readonly`isErr

isErr: false

Always false — use this to narrow the union to OkResult<T>.

`Readonly`isOk

isOk: true

Always true — use this to narrow the union to OkResult<T>.

`Readonly`value

value: T

The success value.

Methods

andThen

andThen<U, F>(fn: (value: T) => Result<U, F>): Result<U, F>
Calls fn(value) and returns its Result.
Type Parameters
- U
- F
Parameters
- fn: (value: T) => Result<U, F>
Returns Result<U, F>
- Defined in packages/core/src/result.ts:37

map

map<U>(fn: (value: T) => U): OkResult<U>
Returns an OkResult with fn(value).
Type Parameters
- U
Parameters
- fn: (value: T) => U
Returns OkResult<U>
- Defined in packages/core/src/result.ts:32

mapErr

mapErr<F>(_fn: (error: never) => F): OkResult<T>
Returns this unchanged.
Type Parameters
- F
Parameters
- _fn: (error: never) => F
Returns OkResult<T>
- Defined in packages/core/src/result.ts:35

match

match<U>(onOk: (value: T) => U, _onErr: (error: never) => U): U
Calls onOk and returns its result.
Type Parameters
- U
Parameters
- onOk: (value: T) => U
- _onErr: (error: never) => U
Returns U
- Defined in packages/core/src/result.ts:39

unwrapOr

unwrapOr(_fallback: T): T
Returns value.
Parameters
- _fallback: T
Returns T
- Defined in packages/core/src/result.ts:41