ts-data-forge/dist/functional/ternary-result/impl/ternary-result-unwrap-warn-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, type UnwrapWarn } from './types.mjs';
/**
 * Returns the Warn value or throws if the result is not Warn.
 *
 * @example
 *
 * ```ts
 * const warnValue = TernaryResult.warn('pending', 'check logs');
 *
 * assert.strictEqual(TernaryResult.unwrapWarnThrow(warnValue), 'check logs');
 *
 * assert.throws(
 *   () => TernaryResult.unwrapWarnThrow(TernaryResult.err('err')),
 *   /Expected Warn/u,
 * );
 * ```
 */
export declare const unwrapWarnThrow: <R extends UnknownTernaryResult>(result: R, toStr?: (value: UnwrapOk<R> | UnwrapErr<R>) => string) => UnwrapWarn<R>;
//# sourceMappingURL=ternary-result-unwrap-warn-throw.d.mts.map