ts-data-forge/dist/functional/result/impl/result-unwrap-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 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.
 *
 * @example
 *
 * ```ts
 * const okResult = Result.ok('data');
 *
 * const errResult = Result.err(new Error('fail'));
 *
 * assert.isTrue(Result.unwrapThrow(okResult) === 'data');
 *
 * assert.throws(() => Result.unwrapThrow(errResult), /fail/u);
 * ```
 *
 * @template R The `UnknownResult` type to unwrap.
 * @param result The `Result` to unwrap.
 * @param toStr An optional function to convert the error value to a string
 *   for the error message. Defaults to `String`.
 * @returns The success value if `Result.Ok`.
 * @throws {Error} Error with the stringified error value if the `Result` is
 *   `Result.Err`.
 */
export declare const unwrapThrow: <R extends UnknownResult>(result: R, toStr?: (e: UnwrapErr<R>) => string) => UnwrapOk<R>;
//# sourceMappingURL=result-unwrap-throw.d.mts.map