ra-core/dist/store/useRemoveFromStore.js

Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React

import { useCallback } from 'react';
import { useStoreContext } from "./useStoreContext.js";
/**
 * Get a callback to remove an item from the store
 *
 * @example
 * import { useRemoveFromStore } from 'react-admin';
 *
 * const ResetDatagridPrefs = () {
 *    const removeItem = useRemoveFromStore();
 *
 *    const handleClick = () => {
 *        removeItem('datagrid.prefs');
 *    };
 *
 *    return <Button onClick={hancleClick}>Reset datagrid preferences</Button>;
 * }
 */
export const useRemoveFromStore = (hookTimeKey) => {
    const { removeItem } = useStoreContext();
    return useCallback((key) => {
        if (typeof key === 'undefined' &&
            typeof hookTimeKey === 'undefined') {
            throw new Error('You must provide a key to remove an item from the store');
        }
        // @ts-ignore
        return removeItem(key ?? hookTimeKey);
    }, [removeItem, hookTimeKey]);
};
//# sourceMappingURL=useRemoveFromStore.js.map