@future-widget-lab/safe-ops/dist/helpers/safe-for-each-with-errors/safe-for-each-with-errors.helper.d.ts

A set of helper functions for performing operations safely, preventing runtime errors from disrupting your application.

import type { ErrorReport, OnError } from '../../types/errors.type';
import type { ForEachCallback } from '../../types/for-each.type';
/**
 * @description
 * Use this helper to execute a function for each element in an array.
 *
 * This function behaves similarly to `Array.prototype.forEach`, but with added error handling:
 * - If the callback throws an error for any element, the error is handled via the onError callback.
 * - Collects errors in an array and returns it in the report.
 * - Allows for custom error handling through the onError option.
 *
 * @param {Array<TInput>} collection The array of items to iterate over.
 * @param {ForEachCallback<TInput>} callback The function to execute for each element.
 * @param {{ onError?: OnError<TInput> }} options An optional object for error handling.
 */
export declare const safeForEachWithErrors: <TInput>(collection: Array<TInput>, callback: ForEachCallback<TInput>, options?: {
    onError?: OnError<TInput>;
}) => {
    errors: Array<ErrorReport<TInput>>;
};