@future-widget-lab/safe-ops
Version:
A set of helper functions for performing operations safely, preventing runtime errors from disrupting your application.
19 lines (18 loc) • 940 B
TypeScript
import type { OnError } from '../../types/errors.type';
import type { Reducer } from '../../types/reduce.type';
/**
* @description
* Use this helper to create an accumulated result given an array and an initial value.
* - If the reducer throws an error for any element, the error is handled via the onError callback.
* - Allows for custom error handling through the onError option.
*
* @param {Array<TInput>} collection The array to reduce.
* @param {Reducer<TInput, TOutput>} reducer A function that processes each element.
* @param {TOutput} initialValue The initial value for the accumulator.
* @param {{ onError?: OnError<TInput> }} options Optional error handling configuration.
*
* @returns {TOutput} The accumulated result.
*/
export declare const safeReduce: <TInput, TOutput>(collection: Array<TInput>, reducer: Reducer<TInput, TOutput>, initialValue: TOutput, options?: {
onError?: OnError<TInput>;
}) => TOutput;