Documentation
    Preparing search index...

    Type Alias Result

    type Result = {
        Err: <T, E>(error?: E) => Result<T, E>;
        isErr: <T, E>(result: Result<T, E>) => result is { error: E; ok: false };
        isOk: <T, E>(result: Result<T, E>) => result is { ok: true; value: T };
        isUnknownError: <T, E>(
            result: Result<T, E>,
        ) => result is { error: never; ok: false };
        Ok: <T, E>(value?: T) => Result<T, E>;
    }
    Index

    Properties

    Err isErr isOk isUnknownError Ok

    Properties

    Err: <T, E>(error?: E) => Result<T, E> = ...

    Create a Result that contains an error.

    Type declaration

      • <T, E>(error?: E): Result<T, E>

      • Type Parameters

        • T

          The type of the value to not contain.

        • E

          The type of the error to contain.

        Parameters

        • Optionalerror: E

        Returns Result<T, E>

        Result

    Result.Err('error') // => { ok: false, error: 'error' }
    Result.Err() // => { ok: false, error: undefined }
    isErr: <T, E>(result: Result<T, E>) => result is { error: E; ok: false } = ...

    Check if a Result is an error.

    Type declaration

      • <T, E>(result: Result<T, E>): result is { error: E; ok: false }

      • Type Parameters

        • T
        • E

        Parameters

        Returns result is { error: E; ok: false }

        true if the Result is an error, otherwise false.

    isOk: <T, E>(result: Result<T, E>) => result is { ok: true; value: T } = ...

    Check if a Result is OK.

    Type declaration

      • <T, E>(result: Result<T, E>): result is { ok: true; value: T }

      • Type Parameters

        • T
        • E

        Parameters

        Returns result is { ok: true; value: T }

        true if the Result is OK, otherwise false.

    isUnknownError: <T, E>(
        result: Result<T, E>,
    ) => result is { error: never; ok: false } = ...

    Check if a Result is an unknown error (error field is undefined).

    Type declaration

      • <T, E>(result: Result<T, E>): result is { error: never; ok: false }

      • Type Parameters

        • T
        • E

        Parameters

        Returns result is { error: never; ok: false }

        true if the Result is an unknwon error, otherwise false.

    Ok: <T, E>(value?: T) => Result<T, E> = ...

    Create a Result that contains a value.

    Type declaration

      • <T, E>(value?: T): Result<T, E>

      • Type Parameters

        • T

          The type of the value to contain.

        • E

          The type of the error to not contain.

        Parameters

        • Optionalvalue: T

        Returns Result<T, E>

        Result

    Result.Ok(42) // => { ok: true, value: 42 }
    Result.Ok() // => { ok: true, value: undefined }

    Settings

    Member Visibility

    On This Page

    Properties