ts-data-forge
    Preparing search index...
    • Unwraps a Result, returning the success value. Throws an error if the Result is Result.Err.

      This is useful when you're confident that a Result should contain a success value and want to treat errors as exceptional conditions. The error message will be constructed from the error value using the provided string conversion function.

      Type Parameters

      • R extends Result.Base

        The Result.Base type to unwrap.

      Parameters

      • result: R

        The Result to unwrap.

      • toStr: (e: UnwrapErr<R>) => string = toStr_

        An optional function to convert the error value to a string for the error message. Defaults to String.

      Returns UnwrapOk<R>

      The success value if Result.Ok.

      const okResult = Result.ok('data');
      const errResult = Result.err(new Error('fail'));

      assert(Result.unwrapThrow(okResult) === 'data');
      assert.throws(() => Result.unwrapThrow(errResult), /fail/u);

      Error with the stringified error value if the Result is Result.Err.