@aivron/sync-storage/src/hooks.ts

A universal, synchronous storage solution for React (web & desktop) with support for core operations, bulk actions, JSON, TTL, and React hooks. For React Native, use @aivron/async-storage.

// src/hooks.ts

import { useEffect, useCallback } from "react";
import { removeStorageKeys, StorageType, getDefaultStorage } from "./bulk";

/**
 * A React hook that performs storage cleanup based on a predicate.
 * This hook is intended for React web and desktop (Electron) projects.
 *
 * @param predicate - A function that returns true for keys to remove.
 * @param storage - Optional custom storage adapter (defaults to localStorage).
 */
export function useStorageCleanup(
    predicate: (key: string) => boolean,
    storage?: StorageType
): void {
    const storageInstance = storage || getDefaultStorage();
    const cleanup = useCallback(() => {
        removeStorageKeys(predicate, storageInstance);
    }, [predicate, storageInstance]);

    useEffect(() => {
        cleanup();
    }, [cleanup]);
}