graphql-react/public/useCacheEntryPrunePrevention.js

'use strict';

const { useCallback, useEffect } = require('react');
const createArgErrorMessageProd = require('../private/createArgErrorMessageProd');
const useCache = require('./useCache');

/**
 * A React hook to prevent a [cache]{@link Cache#store} entry from being pruned,
 * by canceling the cache entry deletion for
 * [prune events]{@link Cache#event:prune} with `event.preventDefault()`.
 * @kind function
 * @name useCacheEntryPrunePrevention
 * @param {CacheKey} cacheKey Cache key.
 * @example <caption>Ways to `import`.</caption>
 * ```js
 * import { useCacheEntryPrunePrevention } from 'graphql-react';
 * ```
 *
 * ```js
 * import useCacheEntryPrunePrevention from 'graphql-react/public/useCacheEntryPrunePrevention.js';
 * ```
 * @example <caption>Ways to `require`.</caption>
 * ```js
 * const { useCacheEntryPrunePrevention } = require('graphql-react');
 * ```
 *
 * ```js
 * const useCacheEntryPrunePrevention = require('graphql-react/public/useCacheEntryPrunePrevention');
 * ```
 */
module.exports = function useCacheEntryPrunePrevention(cacheKey) {
  if (typeof cacheKey !== 'string')
    throw new TypeError(
      typeof process === 'object' && process.env.NODE_ENV !== 'production'
        ? 'Argument 1 `cacheKey` must be a string.'
        : createArgErrorMessageProd(1)
    );

  const cache = useCache();

  const onCacheEntryPrune = useCallback((event) => {
    event.preventDefault();
  }, []);

  useEffect(() => {
    const eventNamePrune = `${cacheKey}/prune`;

    cache.addEventListener(eventNamePrune, onCacheEntryPrune);

    return () => {
      cache.removeEventListener(eventNamePrune, onCacheEntryPrune);
    };
  }, [cache, cacheKey, onCacheEntryPrune]);
};