graphql-react/cacheEntryStale.mjs

A GraphQL client for React using modern context and hooks APIs that’s lightweight (< 4 kB) but powerful; the first Relay and Apollo alternative with server side rendering.

// @ts-check

import Cache from "./Cache.mjs";

/** @typedef {import("./Cache.mjs").CacheEventMap} CacheEventMap */

/**
 * Stales a {@link Cache.store cache store} entry (throwing an error if missing)
 * by dispatching the {@linkcode Cache} event
 * {@link CacheEventMap.stale `stale`} to signal it should probably be reloaded.
 * @param {Cache} cache Cache to update.
 * @param {import("./Cache.mjs").CacheKey} cacheKey Cache key.
 */
export default function cacheEntryStale(cache, cacheKey) {
  if (!(cache instanceof Cache))
    throw new TypeError("Argument 1 `cache` must be a `Cache` instance.");

  if (typeof cacheKey !== "string")
    throw new TypeError("Argument 2 `cacheKey` must be a string.");

  if (!(cacheKey in cache.store))
    throw new Error(`Cache key \`${cacheKey}\` isn’t in the store.`);

  cache.dispatchEvent(new CustomEvent(`${cacheKey}/stale`));
}