@equinor/fusion-query/dist/esm/cache/actions.js

Reactive data fetching and caching library with observable streams and comprehensive event system

import { createAction } from '@equinor/fusion-observable';
/**
 * Creates a set of actions to manipulate cache entries.
 *
 * @template TType The type of the value being cached.
 * @template TArgs The type of the arguments associated with the cache entry.
 * @returns An object containing the cache actions.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export default function createActions() {
    return {
        /**
         * Action to set a cache entry.
         *
         * @param key The cache key.
         * @param record The cache record to set.
         * @returns An action object with the cache key and record.
         */
        set: createAction('cache/set', (key, record) => ({
            payload: { key, record },
        })),
        /**
         * Action to set a cache entry.
         *
         * @param key The cache key.
         * @param entry The cache entry, including value, arguments, and transaction identifier.
         * @returns An action object with the cache key and entry.
         */
        insert: createAction('cache/insert', (key, entry) => {
            return { payload: { key, entry } };
        }),
        /**
         * Action to remove a cache entry.
         *
         * @param key The cache key to remove.
         * @returns An action object with the cache key.
         */
        remove: createAction('cache/remove', (key) => ({ payload: key })),
        /**
         * Action to invalidate a cache entry.
         *
         * @param key The cache key to invalidate.
         * @returns An action object with the cache key.
         */
        invalidate: createAction('cache/invalidate', (key, item) => ({
            payload: key,
            meta: { item },
        })),
        /**
         * Action to mutate a cache entry.
         *
         * @param changes An object containing the cache key, new value, and optional updated timestamp and transaction identifier.
         * @param current The current cache record, if available.
         * @returns An action object with the changes to be applied to the cache entry and the current cache record as metadata.
         */
        mutate: createAction('cache/mutate', (key, changes, item) => ({
            payload: { ...changes, key },
            meta: { item },
        })),
        /**
         * Action to trim the cache based on certain criteria.
         *
         * @param payload Object containing optional sort function, validation function, and size limit.
         * @returns An action object with the payload.
         */
        trim: createAction('cache/trim', (payload) => {
            return { payload };
        }),
    };
}
/**
 * The singleton actions object containing all cache manipulation actions.
 */
export const actions = createActions();
//# sourceMappingURL=actions.js.map