ts-data-forge/dist/functional/result/impl/result-fold.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';
/**
 * Applies one of two functions depending on whether the `Result` is `Ok` or
 * `Err`.
 *
 * @example
 *
 * ```ts
 * const okValue = Result.ok(2);
 *
 * const errValue = Result.err('bad');
 *
 * const foldedOk = Result.fold(
 *   okValue,
 *   (value) => value * 2,
 *   (error) => error,
 * );
 *
 * const foldedErr = Result.fold(
 *   errValue,
 *   (value: number) => value * 2,
 *   (error) => error.toUpperCase(),
 * );
 *
 * assert.deepStrictEqual(foldedOk, Result.ok(4));
 *
 * assert.deepStrictEqual(foldedErr, Result.err('BAD'));
 *
 * const foldNumbers = Result.fold(
 *   (value: number) => value * 3,
 *   (error: string) => error.length,
 * );
 *
 * assert.deepStrictEqual(foldNumbers(Result.ok(3)), Result.ok(9));
 *
 * assert.deepStrictEqual(foldNumbers(Result.err('oops')), Result.err(4));
 * ```
 *
 * @template R The input `UnknownResult` type.
 * @template S2 The type of the success value returned by `mapFn`.
 * @template E2 The type of the error value returned by `mapErrFn`.
 * @param result The `Result` to fold.
 * @param mapFn The function to apply if `result` is `Ok`.
 * @param mapErrFn The function to apply if `result` is `Err`.
 * @returns A new `Result<S2, E2>` based on the applied function.
 */
export declare function fold<R extends UnknownResult, S2, E2>(result: R, mapFn: (value: UnwrapOk<R>) => S2, mapErrFn: (error: UnwrapErr<R>) => E2): Result<S2, E2>;
export declare function fold<S, E, S2, E2>(mapFn: (value: S) => S2, mapErrFn: (error: E) => E2): (result: Result<S, E>) => Result<S2, E2>;
//# sourceMappingURL=result-fold.d.mts.map