ts-fortress
    Preparing search index...

    Variable unwrapErrConst

    unwrapErr: <R extends UnknownResult>(result: R) => UnwrapErr<R> | undefined

    Unwraps a Result, returning the error value or undefined if it is Result.Ok.

    This provides a safe way to extract error values from Results without throwing exceptions. Useful for error handling patterns where you want to check for specific error conditions.

    Type Declaration

      • <R extends UnknownResult>(result: R): UnwrapErr<R> | undefined

      • Type Parameters

        • R extends UnknownResult

          The UnknownResult type to unwrap.

        Parameters

        • result: R

          The Result to unwrap.

        Returns UnwrapErr<R> | undefined

        The error value if Result.Err, otherwise undefined.

    const okResult = Result.ok('data');

    const errResult = Result.err('problem');

    // Result.unwrapErr returns undefined for Ok results

    // eslint-disable-next-line @typescript-eslint/no-confusing-void-expression
    assert.isTrue(Result.unwrapErr(okResult) === undefined);

    // Result.unwrapErr returns the error value for Err results

    assert.isTrue(Result.unwrapErr(errResult) === 'problem');

    Settings
    Member Visibility