Interface Ok<T>

The success leaf of a result. Carries a value (defaulting to void, so a valueless success is Ok<void>) and a success: true discriminant.

interface Ok<T = void> {
    success: true;
    value: T;
    isBad(): this is never;
    isOk(): this is Ok<T>;
}

Type Parameters

T = void
The type of the success value.

Index

Properties

Methods

Properties

`Readonly`success

success: true

Discriminant marking this leaf as a success (always true).

`Readonly`value

value: T

The success value.

Methods

isBad

isBad(): this is never
Type guard narrowing to Bad — always false for an Ok.

Returns this is never
- Defined in work/simple-monad/simple-monad/src/lib/Ok.ts:23

isOk

isOk(): this is Ok<T>
Type guard narrowing to Ok — always true for an Ok.

Returns this is Ok<T>
- Defined in work/simple-monad/simple-monad/src/lib/Ok.ts:18