ts-data-forge/dist/functional/result/impl/result-unwrap-err-throw.d.mts

[](https://www.npmjs.com/package/ts-data-forge) [](https://www.npmjs.com/package/ts-data-forge) [![License](https://img.shields.

import { type UnwrapErr, type UnwrapOk } from './types.mjs';
/**
 * Unwraps a `Result`, returning the error value. Throws an error if the
 * `Result` is `Result.Ok`.
 *
 * This function is used when you expect a Result to be an error and want to
 * extract the error value. If the Result is unexpectedly Ok, it will throw an
 * error with information about the unexpected success value.
 *
 * @example
 *
 * ```ts
 * const errResult = Result.err(new Error('broken'));
 *
 * const okResult = Result.ok('value');
 *
 * assert.isTrue(Result.unwrapErrThrow(errResult).message === 'broken');
 *
 * assert.throws(() => Result.unwrapErrThrow(okResult), /Expected Err/u);
 * ```
 *
 * @template R The `UnknownResult` type to unwrap.
 * @param result The `Result` to unwrap.
 * @param toStr An optional function to convert the success value to a string
 *   for the error message when the Result is unexpectedly Ok. Defaults to
 *   `String`.
 * @returns The error value if `Result.Err`.
 * @throws {Error} Error with message "Expected Err but got Ok: {value}" if
 *   the `Result` is `Result.Ok`.
 */
export declare const unwrapErrThrow: <R extends UnknownResult>(result: R, toStr?: (v: UnwrapOk<R>) => string) => UnwrapErr<R>;
//# sourceMappingURL=result-unwrap-err-throw.d.mts.map