@future-widget-lab/safe-ops/dist/helpers/safe-map-with-errors/safe-map-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 { Transformer } from '../../types/map.type';
/**
 * @description
 * Use this helper to transform an array of items into a new array of items.
 *
 * This function behaves similarly to `Array.prototype.map`, but with added error handling:
 * - If the transformer 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 transform.
 * @param {Transformer<TInput>} transformer The function that transforms the items. Called once for each item in the array.
 * @param {{ onError?: OnError<TInput> }} options An optional object for error handling.
 *
 * @returns {{ results: Array<TOutput>; errors: Array<ErrorReport<TInput>> }} A report which contains the array of items that match the predicate and the errors that occurred.
 */
export declare const safeMapWithErrors: <TInput, TOutput>(collection: Array<TInput>, transformer: Transformer<TInput, TOutput>, options?: {
    onError?: OnError<TInput>;
}) => {
    results: Array<TOutput>;
    errors: Array<ErrorReport<TInput>>;
};