@future-widget-lab/ui-filters/dist/helpers/set-filter-value/set-filter-value.helper.d.ts

A set of primitives for handling filters through search parameters in React applications.

import type { Filters, FilterValue } from '../../types/filters.type';
export type SetFilterValueOptions = {
    /**
     * @description
     * The filters collection.
     */
    filters: Filters;
    /**
     * @description
     * The name of the filter which should be updated.
     */
    name: string;
    /**
     * @description
     * The value that is being added or removed to/from the given filter name.
     */
    value: FilterValue | Array<FilterValue> | null | undefined;
};
/**
 * @description
 * Use this helper to set the value(s) of a given filter.
 *
 * - If `value` is `null`, `undefined`, or an empty array, the filter is removed.
 * - If `value` is a single item, it replaces the existing filter values.
 * - If `value` is an array, all existing filter values are cleared before adding the new ones.
 *
 * This ensures that each filter is updated in a controlled manner:
 * - Existing filter values are first removed using `removeFilterValue`.
 * - New filter values are then added using `addFilterValue`.
 * - If no values remain, `removeFilter` is used to delete the filter entirely.
 *
 * Comparison checks are performed as follows:
 * - Object values are serialized into strings for accurate comparison.
 * - Primitive values (strings, numbers, etc.) are compared directly without serialization.
 *
 * This function maintains immutability by returning a new filters object.
 */
export declare const setFilterValue: (options: SetFilterValueOptions) => Filters;