@tanstack/query-core 5.102.7 → 5.103.0

package/build/modern/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","names":[],"sources":["../../src/utils.ts"],"sourcesContent":["import { timeoutManager } from './timeoutManager'\nimport type {\n  DefaultError,\n  FetchStatus,\n  MutationKey,\n  MutationStatus,\n  QueryFunction,\n  QueryKey,\n  QueryOptions,\n} from './types'\nimport type { Mutation } from './mutation'\nimport type { FetchOptions, Query } from './query'\n\n// TYPES\n\ntype DropLast<T extends ReadonlyArray<unknown>> = T extends readonly [\n  ...infer R,\n  unknown,\n]\n  ? readonly [...R]\n  : never\n\ntype TuplePrefixes<T extends ReadonlyArray<unknown>> = T extends readonly []\n  ? readonly []\n  : TuplePrefixes<DropLast<T>> | T\n\nexport interface QueryFilters<TQueryKey extends QueryKey = QueryKey> {\n  /**\n   * Filter to active queries, inactive queries or all queries\n   */\n  type?: QueryTypeFilter\n  /**\n   * Match query key exactly\n   */\n  exact?: boolean\n  /**\n   * Include queries matching this predicate function\n   */\n  predicate?: (query: Query) => boolean\n  /**\n   * Include queries matching this query key\n   */\n  queryKey?: TQueryKey | TuplePrefixes<TQueryKey>\n  /**\n   * Include or exclude stale queries\n   */\n  stale?: boolean\n  /**\n   * Include queries matching their fetchStatus\n   */\n  fetchStatus?: FetchStatus\n}\n\nexport interface MutationFilters<\n  TData = unknown,\n  TError = DefaultError,\n  TVariables = unknown,\n  TOnMutateResult = unknown,\n> {\n  /**\n   * Match mutation key exactly\n   */\n  exact?: boolean\n  /**\n   * Include mutations matching this predicate function\n   */\n  predicate?: (\n    mutation: Mutation<TData, TError, TVariables, TOnMutateResult>,\n  ) => boolean\n  /**\n   * Include mutations matching this mutation key\n   */\n  mutationKey?: TuplePrefixes<MutationKey>\n  /**\n   * Filter by mutation status\n   */\n  status?: MutationStatus\n}\n\nexport type Updater<TInput, TOutput> = TOutput | ((input: TInput) => TOutput)\n\nexport type QueryTypeFilter = 'all' | 'active' | 'inactive'\n\n// UTILS\n\n/** @deprecated\n * use `environmentManager.isServer()` instead.\n */\nexport const isServer = typeof window === 'undefined' || 'Deno' in globalThis\n\nexport function noop(): void\nexport function noop(): undefined\nexport function noop() {}\n\nexport function functionalUpdate<TInput, TOutput>(\n  updater: Updater<TInput, TOutput>,\n  input: TInput,\n): TOutput {\n  return typeof updater === 'function'\n    ? (updater as (_: TInput) => TOutput)(input)\n    : updater\n}\n\nexport function isValidTimeout(value: unknown): value is number {\n  return typeof value === 'number' && value >= 0 && value !== Infinity\n}\n\nexport function timeUntilStale(updatedAt: number, staleTime?: number): number {\n  return Math.max(updatedAt + (staleTime || 0) - Date.now(), 0)\n}\n\nexport function resolveQueryValue<\n  TValue,\n  TQueryFnData = unknown,\n  TError = DefaultError,\n  TData = TQueryFnData,\n  TQueryKey extends QueryKey = QueryKey,\n>(\n  value:\n    | undefined\n    | TValue\n    | ((query: Query<TQueryFnData, TError, TData, TQueryKey>) => TValue),\n  query: Query<TQueryFnData, TError, TData, TQueryKey>,\n): TValue | undefined {\n  return typeof value === 'function'\n    ? (\n        value as (\n          query: Query<TQueryFnData, TError, TData, TQueryKey>,\n        ) => TValue\n      )(query)\n    : value\n}\n\nexport function matchQuery(\n  filters: QueryFilters,\n  query: Query<any, any, any, any>,\n): boolean {\n  const {\n    type = 'all',\n    exact,\n    fetchStatus,\n    predicate,\n    queryKey,\n    stale,\n  } = filters\n\n  if (queryKey) {\n    if (exact) {\n      if (query.queryHash !== hashQueryKeyByOptions(queryKey, query.options)) {\n        return false\n      }\n    } else if (!partialMatchKey(query.queryKey, queryKey)) {\n      return false\n    }\n  }\n\n  if (type !== 'all') {\n    const isActive = query.isActive()\n    if (type === 'active' && !isActive) {\n      return false\n    }\n    if (type === 'inactive' && isActive) {\n      return false\n    }\n  }\n\n  if (typeof stale === 'boolean' && query.isStale() !== stale) {\n    return false\n  }\n\n  if (fetchStatus && fetchStatus !== query.state.fetchStatus) {\n    return false\n  }\n\n  if (predicate && !predicate(query)) {\n    return false\n  }\n\n  return true\n}\n\nexport function matchMutation(\n  filters: MutationFilters,\n  mutation: Mutation<any, any>,\n): boolean {\n  const { exact, status, predicate, mutationKey } = filters\n  if (mutationKey) {\n    if (!mutation.options.mutationKey) {\n      return false\n    }\n    if (exact) {\n      if (hashKey(mutation.options.mutationKey) !== hashKey(mutationKey)) {\n        return false\n      }\n    } else if (!partialMatchKey(mutation.options.mutationKey, mutationKey)) {\n      return false\n    }\n  }\n\n  if (status && mutation.state.status !== status) {\n    return false\n  }\n\n  if (predicate && !predicate(mutation)) {\n    return false\n  }\n\n  return true\n}\n\nexport function hashQueryKeyByOptions<TQueryKey extends QueryKey = QueryKey>(\n  queryKey: TQueryKey,\n  options?: Pick<QueryOptions<any, any, any, any>, 'queryKeyHashFn'>,\n): string {\n  const hashFn = options?.queryKeyHashFn || hashKey\n  return hashFn(queryKey)\n}\n\n/**\n * Default query & mutation keys hash function.\n * Hashes the value into a stable hash.\n */\nexport function hashKey(queryKey: QueryKey | MutationKey): string {\n  return JSON.stringify(queryKey, (_, val) =>\n    isPlainObject(val)\n      ? Object.keys(val)\n          .sort()\n          .reduce((result, key) => {\n            result[key] = val[key]\n            return result\n          }, {} as any)\n      : val,\n  )\n}\n\n/**\n * Checks if key `b` partially matches with key `a`.\n */\nexport function partialMatchKey(a: QueryKey, b: QueryKey): boolean\nexport function partialMatchKey(a: any, b: any): boolean {\n  if (a === b) {\n    return true\n  }\n\n  if (typeof a !== typeof b) {\n    return false\n  }\n\n  if (a && b && typeof a === 'object' && typeof b === 'object') {\n    if (Array.isArray(a) && Array.isArray(b)) {\n      for (let i = 0; i < b.length; i++) {\n        if (!partialMatchKey(a[i], b[i])) {\n          return false\n        }\n      }\n      return true\n    }\n\n    const bKeys = Object.keys(b)\n    for (const key of bKeys) {\n      if (!partialMatchKey(a[key], b[key])) {\n        return false\n      }\n    }\n    return true\n  }\n\n  return false\n}\n\nconst hasOwn = Object.prototype.hasOwnProperty\n\n/**\n * This function returns `a` if `b` is deeply equal.\n * If not, it will replace any deeply equal children of `b` with those of `a`.\n * This can be used for structural sharing between JSON values for example.\n */\nexport function replaceEqualDeep<T>(a: unknown, b: T, depth?: number): T\nexport function replaceEqualDeep(a: any, b: any, depth = 0): any {\n  if (a === b) {\n    return a\n  }\n\n  if (depth > 500) return b\n\n  const array = isPlainArray(a) && isPlainArray(b)\n\n  if (!array && !(isPlainObject(a) && isPlainObject(b))) return b\n\n  const aItems = array ? a : Object.keys(a)\n  const aSize = aItems.length\n  const bItems = array ? b : Object.keys(b)\n  const bSize = bItems.length\n  const copy: any = array ? new Array(bSize) : {}\n\n  let equalItems = 0\n\n  for (let i = 0; i < bSize; i++) {\n    const key: any = array ? i : bItems[i]\n    const aItem = a[key]\n    const bItem = b[key]\n\n    if (aItem === bItem) {\n      copy[key] = aItem\n      if (array ? i < aSize : hasOwn.call(a, key)) equalItems++\n      continue\n    }\n\n    if (\n      aItem === null ||\n      bItem === null ||\n      typeof aItem !== 'object' ||\n      typeof bItem !== 'object'\n    ) {\n      copy[key] = bItem\n      continue\n    }\n\n    const v = replaceEqualDeep(aItem, bItem, depth + 1)\n    copy[key] = v\n    if (v === aItem) equalItems++\n  }\n\n  return aSize === bSize && equalItems === aSize ? a : copy\n}\n\n/**\n * Shallow compare objects.\n */\nexport function shallowEqualObjects<T extends Record<string, any>>(\n  a: T,\n  b: T | undefined,\n): boolean {\n  if (!b || Object.keys(a).length !== Object.keys(b).length) {\n    return false\n  }\n\n  for (const key in a) {\n    if (a[key] !== b[key]) {\n      return false\n    }\n  }\n\n  return true\n}\n\nexport function isPlainArray(value: unknown): value is Array<unknown> {\n  return Array.isArray(value) && value.length === Object.keys(value).length\n}\n\n// Copied from: https://github.com/jonschlinkert/is-plain-object\nexport function isPlainObject(o: any): o is Record<PropertyKey, unknown> {\n  if (!hasObjectPrototype(o)) {\n    return false\n  }\n\n  // If has no constructor\n  const ctor = o.constructor\n  if (ctor === undefined) {\n    return true\n  }\n\n  // If has modified prototype\n  const prot = ctor.prototype\n  if (!hasObjectPrototype(prot)) {\n    return false\n  }\n\n  // If constructor does not have an Object-specific method\n  if (!prot.hasOwnProperty('isPrototypeOf')) {\n    return false\n  }\n\n  // Handles Objects created by Object.create(<arbitrary prototype>)\n  if (Object.getPrototypeOf(o) !== Object.prototype) {\n    return false\n  }\n\n  // Most likely a plain Object\n  return true\n}\n\nfunction hasObjectPrototype(o: any): boolean {\n  return Object.prototype.toString.call(o) === '[object Object]'\n}\n\nexport function sleep(timeout: number): Promise<void> {\n  return new Promise((resolve) => {\n    timeoutManager.setTimeout(resolve, timeout)\n  })\n}\n\nexport function replaceData<\n  TData,\n  TOptions extends QueryOptions<any, any, any, any>,\n>(prevData: TData | undefined, data: TData, options: TOptions): TData {\n  if (typeof options.structuralSharing === 'function') {\n    return options.structuralSharing(prevData, data) as TData\n  } else if (options.structuralSharing !== false) {\n    if (process.env.NODE_ENV !== 'production') {\n      try {\n        return replaceEqualDeep(prevData, data)\n      } catch (error) {\n        console.error(\n          `Structural sharing requires data to be JSON serializable. To fix this, turn off structuralSharing or return JSON-serializable data from your queryFn. [${options.queryHash}]: ${error}`,\n        )\n\n        // Prevent the replaceEqualDeep from being called again down below.\n        throw error\n      }\n    }\n    // Structurally share data between prev and new data if needed\n    return replaceEqualDeep(prevData, data)\n  }\n  return data\n}\n\nexport function keepPreviousData<T>(\n  previousData: T | undefined,\n): T | undefined {\n  return previousData\n}\n\nexport function addToEnd<T>(items: Array<T>, item: T, max = 0): Array<T> {\n  const newItems = [...items, item]\n  return max && newItems.length > max ? newItems.slice(1) : newItems\n}\n\nexport function addToStart<T>(items: Array<T>, item: T, max = 0): Array<T> {\n  const newItems = [item, ...items]\n  return max && newItems.length > max ? newItems.slice(0, -1) : newItems\n}\n\nexport const skipToken = Symbol()\nexport type SkipToken = typeof skipToken\n\nexport function ensureQueryFn<\n  TQueryFnData = unknown,\n  TQueryKey extends QueryKey = QueryKey,\n>(\n  options: {\n    queryFn?: QueryFunction<TQueryFnData, TQueryKey> | SkipToken\n    queryHash?: string\n  },\n  fetchOptions?: FetchOptions<TQueryFnData>,\n): QueryFunction<TQueryFnData, TQueryKey> {\n  if (process.env.NODE_ENV !== 'production') {\n    if (options.queryFn === skipToken) {\n      console.error(\n        `Attempted to invoke queryFn when set to skipToken. This is likely a configuration error. Query hash: '${options.queryHash}'`,\n      )\n    }\n  }\n\n  // if we attempt to retry a fetch that was triggered from an initialPromise\n  // when we don't have a queryFn yet, we can't retry, so we just return the already rejected initialPromise\n  // if an observer has already mounted, we will be able to retry with that queryFn\n  if (!options.queryFn && fetchOptions?.initialPromise) {\n    return () => fetchOptions.initialPromise!\n  }\n\n  if (!options.queryFn || options.queryFn === skipToken) {\n    return () =>\n      Promise.reject(new Error(`Missing queryFn: '${options.queryHash}'`))\n  }\n\n  return options.queryFn\n}\n\nexport function shouldThrowError<T extends (...args: Array<any>) => boolean>(\n  throwOnError: boolean | T | undefined,\n  params: Parameters<T>,\n): boolean {\n  // Allow throwOnError function to override throwing behavior on a per-error basis\n  if (typeof throwOnError === 'function') {\n    return throwOnError(...params)\n  }\n\n  return !!throwOnError\n}\n\nexport function addConsumeAwareSignal<T>(\n  object: T,\n  getSignal: () => AbortSignal,\n  onCancelled: VoidFunction,\n): T & { signal: AbortSignal } {\n  let consumed = false\n  let signal: AbortSignal | undefined\n\n  Object.defineProperty(object, 'signal', {\n    enumerable: true,\n    get: () => {\n      signal ??= getSignal()\n      if (consumed) {\n        return signal\n      }\n\n      consumed = true\n      if (signal.aborted) {\n        onCancelled()\n      } else {\n        signal.addEventListener('abort', onCancelled, { once: true })\n      }\n\n      return signal\n    },\n  })\n\n  return object as T & { signal: AbortSignal }\n}\n"],"mappings":";;;;;AAwFA,MAAa,WAAW,OAAO,WAAW,eAAe,UAAU;AAInE,SAAgB,OAAO,CAAC;AAExB,SAAgB,iBACd,SACA,OACS;CACT,OAAO,OAAO,YAAY,aACrB,QAAmC,KAAK,IACzC;AACN;AAEA,SAAgB,eAAe,OAAiC;CAC9D,OAAO,OAAO,UAAU,YAAY,SAAS,KAAK,UAAU;AAC9D;AAEA,SAAgB,eAAe,WAAmB,WAA4B;CAC5E,OAAO,KAAK,IAAI,aAAa,aAAa,KAAK,KAAK,IAAI,GAAG,CAAC;AAC9D;AAEA,SAAgB,kBAOd,OAIA,OACoB;CACpB,OAAO,OAAO,UAAU,aAElB,MAGA,KAAK,IACP;AACN;AAEA,SAAgB,WACd,SACA,OACS;CACT,MAAM,EACJ,OAAO,OACP,OACA,aACA,WACA,UACA,UACE;CAEJ,IAAI,UAAU;EACZ,IAAI,OACE;OAAA,MAAM,cAAc,sBAAsB,UAAU,MAAM,OAAO,GACnE,OAAO;EAAA,OAEJ,IAAI,CAAC,gBAAgB,MAAM,UAAU,QAAQ,GAClD,OAAO;CAEX;CAEA,IAAI,SAAS,OAAO;EAClB,MAAM,WAAW,MAAM,SAAS;EAChC,IAAI,SAAS,YAAY,CAAC,UACxB,OAAO;EAET,IAAI,SAAS,cAAc,UACzB,OAAO;CAEX;CAEA,IAAI,OAAO,UAAU,aAAa,MAAM,QAAQ,MAAM,OACpD,OAAO;CAGT,IAAI,eAAe,gBAAgB,MAAM,MAAM,aAC7C,OAAO;CAGT,IAAI,aAAa,CAAC,UAAU,KAAK,GAC/B,OAAO;CAGT,OAAO;AACT;AAEA,SAAgB,cACd,SACA,UACS;CACT,MAAM,EAAE,OAAO,QAAQ,WAAW,gBAAgB;CAClD,IAAI,aAAa;EACf,IAAI,CAAC,SAAS,QAAQ,aACpB,OAAO;EAET,IAAI,OACE;OAAA,QAAQ,SAAS,QAAQ,WAAW,MAAM,QAAQ,WAAW,GAC/D,OAAO;EAAA,OAEJ,IAAI,CAAC,gBAAgB,SAAS,QAAQ,aAAa,WAAW,GACnE,OAAO;CAEX;CAEA,IAAI,UAAU,SAAS,MAAM,WAAW,QACtC,OAAO;CAGT,IAAI,aAAa,CAAC,UAAU,QAAQ,GAClC,OAAO;CAGT,OAAO;AACT;AAEA,SAAgB,sBACd,UACA,SACQ;CAER,QADe,SAAS,kBAAkB,QAAA,CAC5B,QAAQ;AACxB;;;;;AAMA,SAAgB,QAAQ,UAA0C;CAChE,OAAO,KAAK,UAAU,WAAW,GAAG,QAClC,cAAc,GAAG,IACb,OAAO,KAAK,GAAG,CAAC,CACb,KAAK,CAAC,CACN,QAAQ,QAAQ,QAAQ;EACvB,OAAO,OAAO,IAAI;EAClB,OAAO;CACT,GAAG,CAAC,CAAQ,IACd,GACN;AACF;AAMA,SAAgB,gBAAgB,GAAQ,GAAiB;CACvD,IAAI,MAAM,GACR,OAAO;CAGT,IAAI,OAAO,MAAM,OAAO,GACtB,OAAO;CAGT,IAAI,KAAK,KAAK,OAAO,MAAM,YAAY,OAAO,MAAM,UAAU;EAC5D,IAAI,MAAM,QAAQ,CAAC,KAAK,MAAM,QAAQ,CAAC,GAAG;GACxC,KAAK,IAAI,IAAI,GAAG,IAAI,EAAE,QAAQ,KAC5B,IAAI,CAAC,gBAAgB,EAAE,IAAI,EAAE,EAAE,GAC7B,OAAO;GAGX,OAAO;EACT;EAEA,MAAM,QAAQ,OAAO,KAAK,CAAC;EAC3B,KAAK,MAAM,OAAO,OAChB,IAAI,CAAC,gBAAgB,EAAE,MAAM,EAAE,IAAI,GACjC,OAAO;EAGX,OAAO;CACT;CAEA,OAAO;AACT;AAEA,MAAM,SAAS,OAAO,UAAU;AAQhC,SAAgB,iBAAiB,GAAQ,GAAQ,QAAQ,GAAQ;CAC/D,IAAI,MAAM,GACR,OAAO;CAGT,IAAI,QAAQ,KAAK,OAAO;CAExB,MAAM,QAAQ,aAAa,CAAC,KAAK,aAAa,CAAC;CAE/C,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,KAAK,cAAc,CAAC,IAAI,OAAO;CAG9D,MAAM,SADS,QAAQ,IAAI,OAAO,KAAK,CAAC,EAAA,CACnB;CACrB,MAAM,SAAS,QAAQ,IAAI,OAAO,KAAK,CAAC;CACxC,MAAM,QAAQ,OAAO;CACrB,MAAM,OAAY,QAAQ,IAAI,MAAM,KAAK,IAAI,CAAC;CAE9C,IAAI,aAAa;CAEjB,KAAK,IAAI,IAAI,GAAG,IAAI,OAAO,KAAK;EAC9B,MAAM,MAAW,QAAQ,IAAI,OAAO;EACpC,MAAM,QAAQ,EAAE;EAChB,MAAM,QAAQ,EAAE;EAEhB,IAAI,UAAU,OAAO;GACnB,KAAK,OAAO;GACZ,IAAI,QAAQ,IAAI,QAAQ,OAAO,KAAK,GAAG,GAAG,GAAG;GAC7C;EACF;EAEA,IACE,UAAU,QACV,UAAU,QACV,OAAO,UAAU,YACjB,OAAO,UAAU,UACjB;GACA,KAAK,OAAO;GACZ;EACF;EAEA,MAAM,IAAI,iBAAiB,OAAO,OAAO,QAAQ,CAAC;EAClD,KAAK,OAAO;EACZ,IAAI,MAAM,OAAO;CACnB;CAEA,OAAO,UAAU,SAAS,eAAe,QAAQ,IAAI;AACvD;;;;AAKA,SAAgB,oBACd,GACA,GACS;CACT,IAAI,CAAC,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC,WAAW,OAAO,KAAK,CAAC,CAAC,CAAC,QACjD,OAAO;CAGT,KAAK,MAAM,OAAO,GAChB,IAAI,EAAE,SAAS,EAAE,MACf,OAAO;CAIX,OAAO;AACT;AAEA,SAAgB,aAAa,OAAyC;CACpE,OAAO,MAAM,QAAQ,KAAK,KAAK,MAAM,WAAW,OAAO,KAAK,KAAK,CAAC,CAAC;AACrE;AAGA,SAAgB,cAAc,GAA2C;CACvE,IAAI,CAAC,mBAAmB,CAAC,GACvB,OAAO;CAIT,MAAM,OAAO,EAAE;CACf,IAAI,SAAS,KAAA,GACX,OAAO;CAIT,MAAM,OAAO,KAAK;CAClB,IAAI,CAAC,mBAAmB,IAAI,GAC1B,OAAO;CAIT,IAAI,CAAC,KAAK,eAAe,eAAe,GACtC,OAAO;CAIT,IAAI,OAAO,eAAe,CAAC,MAAM,OAAO,WACtC,OAAO;CAIT,OAAO;AACT;AAEA,SAAS,mBAAmB,GAAiB;CAC3C,OAAO,OAAO,UAAU,SAAS,KAAK,CAAC,MAAM;AAC/C;AAEA,SAAgB,MAAM,SAAgC;CACpD,OAAO,IAAI,SAAS,YAAY;EAC9B,eAAe,WAAW,SAAS,OAAO;CAC5C,CAAC;AACH;AAEA,SAAgB,YAGd,UAA6B,MAAa,SAA0B;CACpE,IAAI,OAAO,QAAQ,sBAAsB,YACvC,OAAO,QAAQ,kBAAkB,UAAU,IAAI;MAC1C,IAAI,QAAQ,sBAAsB,OAAO;EAC9C,IAAI,QAAQ,IAAI,aAAa,cAC3B,IAAI;GACF,OAAO,iBAAiB,UAAU,IAAI;EACxC,SAAS,OAAO;GACd,QAAQ,MACN,0JAA0J,QAAQ,UAAU,KAAK,OACnL;GAGA,MAAM;EACR;EAGF,OAAO,iBAAiB,UAAU,IAAI;CACxC;CACA,OAAO;AACT;AAEA,SAAgB,iBACd,cACe;CACf,OAAO;AACT;AAEA,SAAgB,SAAY,OAAiB,MAAS,MAAM,GAAa;CACvE,MAAM,WAAW,CAAC,GAAG,OAAO,IAAI;CAChC,OAAO,OAAO,SAAS,SAAS,MAAM,SAAS,MAAM,CAAC,IAAI;AAC5D;AAEA,SAAgB,WAAc,OAAiB,MAAS,MAAM,GAAa;CACzE,MAAM,WAAW,CAAC,MAAM,GAAG,KAAK;CAChC,OAAO,OAAO,SAAS,SAAS,MAAM,SAAS,MAAM,GAAG,EAAE,IAAI;AAChE;AAEA,MAAa,YAAY,OAAO;AAGhC,SAAgB,cAId,SAIA,cACwC;CACxC,IAAI,QAAQ,IAAI,aAAa,cACvB;MAAA,QAAQ,YAAY,WACtB,QAAQ,MACN,yGAAyG,QAAQ,UAAU,EAC7H;CAAA;CAOJ,IAAI,CAAC,QAAQ,WAAW,cAAc,gBACpC,aAAa,aAAa;CAG5B,IAAI,CAAC,QAAQ,WAAW,QAAQ,YAAY,WAC1C,aACE,QAAQ,uBAAO,IAAI,MAAM,qBAAqB,QAAQ,UAAU,EAAE,CAAC;CAGvE,OAAO,QAAQ;AACjB;AAEA,SAAgB,iBACd,cACA,QACS;CAET,IAAI,OAAO,iBAAiB,YAC1B,OAAO,aAAa,GAAG,MAAM;CAG/B,OAAO,CAAC,CAAC;AACX;AAEA,SAAgB,sBACd,QACA,WACA,aAC6B;CAC7B,IAAI,WAAW;CACf,IAAI;CAEJ,OAAO,eAAe,QAAQ,UAAU;EACtC,YAAY;EACZ,WAAW;GACT,WAAW,UAAU;GACrB,IAAI,UACF,OAAO;GAGT,WAAW;GACX,IAAI,OAAO,SACT,YAAY;QAEZ,OAAO,iBAAiB,SAAS,aAAa,EAAE,MAAM,KAAK,CAAC;GAG9D,OAAO;EACT;CACF,CAAC;CAED,OAAO;AACT"}
+{"version":3,"file":"utils.js","names":[],"sources":["../../src/utils.ts"],"sourcesContent":["import { timeoutManager } from './timeoutManager'\nimport type {\n  DefaultError,\n  FetchStatus,\n  MutationKey,\n  MutationStatus,\n  QueryFunction,\n  QueryKey,\n  QueryOptions,\n} from './types'\nimport type { Mutation } from './mutation'\nimport type { FetchOptions, Query } from './query'\n\n// TYPES\n\ntype DropLast<T extends ReadonlyArray<unknown>> = T extends readonly [\n  ...infer R,\n  unknown,\n]\n  ? readonly [...R]\n  : never\n\ntype TuplePrefixes<T extends ReadonlyArray<unknown>> = T extends readonly []\n  ? readonly []\n  : TuplePrefixes<DropLast<T>> | T\n\n/**\n * Filters used to select queries, for example in `queryClient.getQueriesData` or `queryClient.invalidateQueries`.\n * All provided filters must match; filters that are left unspecified are ignored.\n */\nexport interface QueryFilters<TQueryKey extends QueryKey = QueryKey> {\n  /**\n   * Filter to active queries, inactive queries or all queries\n   *\n   * Defaults to `'all'`.\n   */\n  type?: QueryTypeFilter\n  /**\n   * Match query key exactly\n   */\n  exact?: boolean\n  /**\n   * Include queries matching this predicate function\n   */\n  predicate?: (query: Query) => boolean\n  /**\n   * Include queries matching this query key\n   */\n  queryKey?: TQueryKey | TuplePrefixes<TQueryKey>\n  /**\n   * Include or exclude stale queries\n   */\n  stale?: boolean\n  /**\n   * Include queries matching their fetchStatus\n   */\n  fetchStatus?: FetchStatus\n}\n\n/**\n * Filters used to select mutations, for example in `mutationCache.findAll` or `queryClient.isMutating`.\n * All provided filters must match; filters that are left unspecified are ignored.\n */\nexport interface MutationFilters<\n  TData = unknown,\n  TError = DefaultError,\n  TVariables = unknown,\n  TOnMutateResult = unknown,\n> {\n  /**\n   * Match mutation key exactly\n   */\n  exact?: boolean\n  /**\n   * Include mutations matching this predicate function\n   */\n  predicate?: (\n    mutation: Mutation<TData, TError, TVariables, TOnMutateResult>,\n  ) => boolean\n  /**\n   * Include mutations matching this mutation key\n   */\n  mutationKey?: TuplePrefixes<MutationKey>\n  /**\n   * Filter by mutation status\n   */\n  status?: MutationStatus\n}\n\n/**\n * Either a plain value of type `TOutput`, or a function that receives `TInput` and returns `TOutput`.\n * Used for example by `setQueryData`-style updaters, which accept either the new data directly or a\n * function that computes it from the previous data. See {@link functionalUpdate}.\n *\n * @example\n * ```ts\n * queryClient.setQueryData(['posts'], newPosts)\n *\n * // Or, using an updater function that receives the current data:\n * queryClient.setQueryData(['posts'], (oldPosts) =>\n *   oldPosts ? [...oldPosts, newPost] : oldPosts,\n * )\n * ```\n */\nexport type Updater<TInput, TOutput> = TOutput | ((input: TInput) => TOutput)\n\nexport type QueryTypeFilter = 'all' | 'active' | 'inactive'\n\n// UTILS\n\n/** @deprecated\n * use `environmentManager.isServer()` instead.\n */\nexport const isServer = typeof window === 'undefined' || 'Deno' in globalThis\n\n/**\n * A function that does nothing.\n */\nexport function noop(): void\nexport function noop(): undefined\nexport function noop() {}\n\nexport function functionalUpdate<TInput, TOutput>(\n  updater: Updater<TInput, TOutput>,\n  input: TInput,\n): TOutput {\n  return typeof updater === 'function'\n    ? (updater as (_: TInput) => TOutput)(input)\n    : updater\n}\n\nexport function isValidTimeout(value: unknown): value is number {\n  return typeof value === 'number' && value >= 0 && value !== Infinity\n}\n\nexport function timeUntilStale(updatedAt: number, staleTime?: number): number {\n  return Math.max(updatedAt + (staleTime || 0) - Date.now(), 0)\n}\n\nexport function resolveQueryValue<\n  TValue,\n  TQueryFnData = unknown,\n  TError = DefaultError,\n  TData = TQueryFnData,\n  TQueryKey extends QueryKey = QueryKey,\n>(\n  value:\n    | undefined\n    | TValue\n    | ((query: Query<TQueryFnData, TError, TData, TQueryKey>) => TValue),\n  query: Query<TQueryFnData, TError, TData, TQueryKey>,\n): TValue | undefined {\n  return typeof value === 'function'\n    ? (\n        value as (\n          query: Query<TQueryFnData, TError, TData, TQueryKey>,\n        ) => TValue\n      )(query)\n    : value\n}\n\n/**\n * Checks whether a query matches the given {@link QueryFilters}.\n * Every filter that is specified must match; filters that are left unspecified are ignored.\n *\n * @example\n * ```ts\n * const queryCache = queryClient.getQueryCache()\n *\n * const matchingQueries = queryCache\n *   .getAll()\n *   .filter((query) => matchQuery({ queryKey: ['posts'] }, query))\n * ```\n */\nexport function matchQuery(\n  filters: QueryFilters,\n  query: Query<any, any, any, any>,\n): boolean {\n  const {\n    type = 'all',\n    exact,\n    fetchStatus,\n    predicate,\n    queryKey,\n    stale,\n  } = filters\n\n  if (queryKey) {\n    if (exact) {\n      if (query.queryHash !== hashQueryKeyByOptions(queryKey, query.options)) {\n        return false\n      }\n    } else if (!partialMatchKey(query.queryKey, queryKey)) {\n      return false\n    }\n  }\n\n  if (type !== 'all') {\n    const isActive = query.isActive()\n    if (type === 'active' && !isActive) {\n      return false\n    }\n    if (type === 'inactive' && isActive) {\n      return false\n    }\n  }\n\n  if (typeof stale === 'boolean' && query.isStale() !== stale) {\n    return false\n  }\n\n  if (fetchStatus && fetchStatus !== query.state.fetchStatus) {\n    return false\n  }\n\n  if (predicate && !predicate(query)) {\n    return false\n  }\n\n  return true\n}\n\n/**\n * Checks whether a mutation matches the given {@link MutationFilters}.\n * Every filter that is specified must match; filters that are left unspecified are ignored.\n * If a `mutationKey` filter is provided but the mutation has no `mutationKey` of its own, it does not match.\n *\n * @example\n * ```ts\n * const mutationCache = queryClient.getMutationCache()\n *\n * const matchingMutations = mutationCache\n *   .getAll()\n *   .filter((mutation) => matchMutation({ mutationKey: ['addPost'] }, mutation))\n * ```\n */\nexport function matchMutation(\n  filters: MutationFilters,\n  mutation: Mutation<any, any>,\n): boolean {\n  const { exact, status, predicate, mutationKey } = filters\n  if (mutationKey) {\n    if (!mutation.options.mutationKey) {\n      return false\n    }\n    if (exact) {\n      if (hashKey(mutation.options.mutationKey) !== hashKey(mutationKey)) {\n        return false\n      }\n    } else if (!partialMatchKey(mutation.options.mutationKey, mutationKey)) {\n      return false\n    }\n  }\n\n  if (status && mutation.state.status !== status) {\n    return false\n  }\n\n  if (predicate && !predicate(mutation)) {\n    return false\n  }\n\n  return true\n}\n\nexport function hashQueryKeyByOptions<TQueryKey extends QueryKey = QueryKey>(\n  queryKey: TQueryKey,\n  options?: Pick<QueryOptions<any, any, any, any>, 'queryKeyHashFn'>,\n): string {\n  const hashFn = options?.queryKeyHashFn || hashKey\n  return hashFn(queryKey)\n}\n\n/**\n * Default query & mutation keys hash function.\n * Hashes the value into a stable hash.\n *\n * @example\n * ```ts\n * // Object keys are sorted, so key order doesn't affect the hash:\n * hashKey(['todos', { page: 1, filter: 'done' }]) // === '[\"todos\",{\"filter\":\"done\",\"page\":1}]'\n * ```\n */\nexport function hashKey(queryKey: QueryKey | MutationKey): string {\n  return JSON.stringify(queryKey, (_, val) =>\n    isPlainObject(val)\n      ? Object.keys(val)\n          .sort()\n          .reduce((result, key) => {\n            result[key] = val[key]\n            return result\n          }, {} as any)\n      : val,\n  )\n}\n\n/**\n * Checks if key `b` partially matches with key `a`.\n */\nexport function partialMatchKey(a: QueryKey, b: QueryKey): boolean\nexport function partialMatchKey(a: any, b: any): boolean {\n  if (a === b) {\n    return true\n  }\n\n  if (typeof a !== typeof b) {\n    return false\n  }\n\n  if (a && b && typeof a === 'object' && typeof b === 'object') {\n    if (Array.isArray(a) && Array.isArray(b)) {\n      if (b.length > a.length) return false\n      for (let i = 0; i < b.length; i++) {\n        if (!partialMatchKey(a[i], b[i])) {\n          return false\n        }\n      }\n      return true\n    }\n\n    const bKeys = Object.keys(b)\n    for (const key of bKeys) {\n      if (!partialMatchKey(a[key], b[key])) {\n        return false\n      }\n    }\n    return true\n  }\n\n  return false\n}\n\nconst hasOwn = Object.prototype.hasOwnProperty\n\n/**\n * This function returns `a` if `b` is deeply equal.\n * If not, it will replace any deeply equal children of `b` with those of `a`.\n * This can be used for structural sharing between JSON values for example.\n */\nexport function replaceEqualDeep<T>(a: unknown, b: T, depth?: number): T\nexport function replaceEqualDeep(a: any, b: any, depth = 0): any {\n  if (a === b) {\n    return a\n  }\n\n  if (depth > 500) return b\n\n  const array = isPlainArray(a) && isPlainArray(b)\n\n  if (!array && !(isPlainObject(a) && isPlainObject(b))) return b\n\n  const aItems = array ? a : Object.keys(a)\n  const aSize = aItems.length\n  const bItems = array ? b : Object.keys(b)\n  const bSize = bItems.length\n  const copy: any = array ? new Array(bSize) : {}\n\n  let equalItems = 0\n\n  for (let i = 0; i < bSize; i++) {\n    const key: any = array ? i : bItems[i]\n    const aItem = a[key]\n    const bItem = b[key]\n\n    if (aItem === bItem) {\n      copy[key] = aItem\n      if (array ? i < aSize : hasOwn.call(a, key)) equalItems++\n      continue\n    }\n\n    if (\n      aItem === null ||\n      bItem === null ||\n      typeof aItem !== 'object' ||\n      typeof bItem !== 'object'\n    ) {\n      copy[key] = bItem\n      continue\n    }\n\n    const v = replaceEqualDeep(aItem, bItem, depth + 1)\n    copy[key] = v\n    if (v === aItem) equalItems++\n  }\n\n  return aSize === bSize && equalItems === aSize ? a : copy\n}\n\n/**\n * Shallow compare objects.\n */\nexport function shallowEqualObjects<T extends Record<string, any>>(\n  a: T,\n  b: T | undefined,\n): boolean {\n  if (!b || Object.keys(a).length !== Object.keys(b).length) {\n    return false\n  }\n\n  for (const key in a) {\n    if (a[key] !== b[key]) {\n      return false\n    }\n  }\n\n  return true\n}\n\nexport function isPlainArray(value: unknown): value is Array<unknown> {\n  return Array.isArray(value) && value.length === Object.keys(value).length\n}\n\n// Copied from: https://github.com/jonschlinkert/is-plain-object\nexport function isPlainObject(o: any): o is Record<PropertyKey, unknown> {\n  if (!hasObjectPrototype(o)) {\n    return false\n  }\n\n  // If has no constructor\n  const ctor = o.constructor\n  if (ctor === undefined) {\n    return true\n  }\n\n  // If has modified prototype\n  const prot = ctor.prototype\n  if (!hasObjectPrototype(prot)) {\n    return false\n  }\n\n  // If constructor does not have an Object-specific method\n  if (!prot.hasOwnProperty('isPrototypeOf')) {\n    return false\n  }\n\n  // Handles Objects created by Object.create(<arbitrary prototype>)\n  if (Object.getPrototypeOf(o) !== Object.prototype) {\n    return false\n  }\n\n  // Most likely a plain Object\n  return true\n}\n\nfunction hasObjectPrototype(o: any): boolean {\n  return Object.prototype.toString.call(o) === '[object Object]'\n}\n\nexport function sleep(timeout: number): Promise<void> {\n  return new Promise((resolve) => {\n    timeoutManager.setTimeout(resolve, timeout)\n  })\n}\n\nexport function replaceData<\n  TData,\n  TOptions extends QueryOptions<any, any, any, any>,\n>(prevData: TData | undefined, data: TData, options: TOptions): TData {\n  if (typeof options.structuralSharing === 'function') {\n    return options.structuralSharing(prevData, data) as TData\n  } else if (options.structuralSharing !== false) {\n    if (process.env.NODE_ENV !== 'production') {\n      try {\n        return replaceEqualDeep(prevData, data)\n      } catch (error) {\n        console.error(\n          `Structural sharing requires data to be JSON serializable. To fix this, turn off structuralSharing or return JSON-serializable data from your queryFn. [${options.queryHash}]: ${error}`,\n        )\n\n        // Prevent the replaceEqualDeep from being called again down below.\n        throw error\n      }\n    }\n    // Structurally share data between prev and new data if needed\n    return replaceEqualDeep(prevData, data)\n  }\n  return data\n}\n\n/**\n * Intended to be passed as a query's `placeholderData` option, for example\n * `placeholderData: keepPreviousData`. Instead of resetting the query's data to `undefined` while a new\n * query key is fetching, it keeps displaying the previously fetched data until the new data arrives.\n *\n * @example\n * ```ts\n * new QueryObserver(queryClient, {\n *   queryKey: ['posts', page],\n *   queryFn: () => fetchPosts(page),\n *   placeholderData: keepPreviousData,\n * })\n * ```\n */\nexport function keepPreviousData<T>(\n  previousData: T | undefined,\n): T | undefined {\n  return previousData\n}\n\nexport function addToEnd<T>(items: Array<T>, item: T, max = 0): Array<T> {\n  const newItems = [...items, item]\n  return max && newItems.length > max ? newItems.slice(1) : newItems\n}\n\nexport function addToStart<T>(items: Array<T>, item: T, max = 0): Array<T> {\n  const newItems = [item, ...items]\n  return max && newItems.length > max ? newItems.slice(0, -1) : newItems\n}\n\n/**\n * Sentinel value that can be passed as a query's `queryFn` to conditionally disable the query (equivalent\n * to `enabled: false`) while preserving full type inference for the query's data. Unlike `enabled: false`,\n * a query disabled via `skipToken` cannot be triggered with `refetch`.\n *\n * @example\n * ```ts\n * new QueryObserver(queryClient, {\n *   queryKey: ['post', postId],\n *   queryFn: postId != null ? () => fetchPost(postId) : skipToken,\n * })\n * ```\n */\nexport const skipToken = Symbol()\n/**\n * The type of the {@link skipToken} sentinel value.\n */\nexport type SkipToken = typeof skipToken\n\nexport function ensureQueryFn<\n  TQueryFnData = unknown,\n  TQueryKey extends QueryKey = QueryKey,\n>(\n  options: {\n    queryFn?: QueryFunction<TQueryFnData, TQueryKey> | SkipToken\n    queryHash?: string\n  },\n  fetchOptions?: FetchOptions<TQueryFnData>,\n): QueryFunction<TQueryFnData, TQueryKey> {\n  if (process.env.NODE_ENV !== 'production') {\n    if (options.queryFn === skipToken) {\n      console.error(\n        `Attempted to invoke queryFn when set to skipToken. This is likely a configuration error. Query hash: '${options.queryHash}'`,\n      )\n    }\n  }\n\n  // if we attempt to retry a fetch that was triggered from an initialPromise\n  // when we don't have a queryFn yet, we can't retry, so we just return the already rejected initialPromise\n  // if an observer has already mounted, we will be able to retry with that queryFn\n  if (!options.queryFn && fetchOptions?.initialPromise) {\n    return () => fetchOptions.initialPromise!\n  }\n\n  if (!options.queryFn || options.queryFn === skipToken) {\n    return () =>\n      Promise.reject(new Error(`Missing queryFn: '${options.queryHash}'`))\n  }\n\n  return options.queryFn\n}\n\n/**\n * Resolves a `throwOnError` option to a boolean.\n * If `throwOnError` is a function, it is called with `params` (e.g. the error and, depending on the caller,\n * additional context such as the query or mutation) and its result is returned, allowing the throwing\n * behavior to be decided per error. Otherwise, `throwOnError` itself is coerced to a boolean (`undefined`\n * resolves to `false`).\n *\n * @example\n * ```ts\n * const throwOnError =\n *   query.state.error && typeof options.throwOnError === 'function'\n *     ? shouldThrowError(options.throwOnError, [query.state.error, query])\n *     : options.throwOnError\n * ```\n */\nexport function shouldThrowError<T extends (...args: Array<any>) => boolean>(\n  throwOnError: boolean | T | undefined,\n  params: Parameters<T>,\n): boolean {\n  // Allow throwOnError function to override throwing behavior on a per-error basis\n  if (typeof throwOnError === 'function') {\n    return throwOnError(...params)\n  }\n\n  return !!throwOnError\n}\n\nexport function addConsumeAwareSignal<T>(\n  object: T,\n  getSignal: () => AbortSignal,\n  onCancelled: VoidFunction,\n): T & { signal: AbortSignal } {\n  let consumed = false\n  let signal: AbortSignal | undefined\n\n  Object.defineProperty(object, 'signal', {\n    enumerable: true,\n    get: () => {\n      signal ??= getSignal()\n      if (consumed) {\n        return signal\n      }\n\n      consumed = true\n      if (signal.aborted) {\n        onCancelled()\n      } else {\n        signal.addEventListener('abort', onCancelled, { once: true })\n      }\n\n      return signal\n    },\n  })\n\n  return object as T & { signal: AbortSignal }\n}\n"],"mappings":";;;;;AAiHA,MAAa,WAAW,OAAO,WAAW,eAAe,UAAU;AAOnE,SAAgB,OAAO,CAAC;AAExB,SAAgB,iBACd,SACA,OACS;CACT,OAAO,OAAO,YAAY,aACrB,QAAmC,KAAK,IACzC;AACN;AAEA,SAAgB,eAAe,OAAiC;CAC9D,OAAO,OAAO,UAAU,YAAY,SAAS,KAAK,UAAU;AAC9D;AAEA,SAAgB,eAAe,WAAmB,WAA4B;CAC5E,OAAO,KAAK,IAAI,aAAa,aAAa,KAAK,KAAK,IAAI,GAAG,CAAC;AAC9D;AAEA,SAAgB,kBAOd,OAIA,OACoB;CACpB,OAAO,OAAO,UAAU,aAElB,MAGA,KAAK,IACP;AACN;;;;;;;;;;;;;;AAeA,SAAgB,WACd,SACA,OACS;CACT,MAAM,EACJ,OAAO,OACP,OACA,aACA,WACA,UACA,UACE;CAEJ,IAAI,UAAU;EACZ,IAAI,OACE;OAAA,MAAM,cAAc,sBAAsB,UAAU,MAAM,OAAO,GACnE,OAAO;EAAA,OAEJ,IAAI,CAAC,gBAAgB,MAAM,UAAU,QAAQ,GAClD,OAAO;CAEX;CAEA,IAAI,SAAS,OAAO;EAClB,MAAM,WAAW,MAAM,SAAS;EAChC,IAAI,SAAS,YAAY,CAAC,UACxB,OAAO;EAET,IAAI,SAAS,cAAc,UACzB,OAAO;CAEX;CAEA,IAAI,OAAO,UAAU,aAAa,MAAM,QAAQ,MAAM,OACpD,OAAO;CAGT,IAAI,eAAe,gBAAgB,MAAM,MAAM,aAC7C,OAAO;CAGT,IAAI,aAAa,CAAC,UAAU,KAAK,GAC/B,OAAO;CAGT,OAAO;AACT;;;;;;;;;;;;;;;AAgBA,SAAgB,cACd,SACA,UACS;CACT,MAAM,EAAE,OAAO,QAAQ,WAAW,gBAAgB;CAClD,IAAI,aAAa;EACf,IAAI,CAAC,SAAS,QAAQ,aACpB,OAAO;EAET,IAAI,OACE;OAAA,QAAQ,SAAS,QAAQ,WAAW,MAAM,QAAQ,WAAW,GAC/D,OAAO;EAAA,OAEJ,IAAI,CAAC,gBAAgB,SAAS,QAAQ,aAAa,WAAW,GACnE,OAAO;CAEX;CAEA,IAAI,UAAU,SAAS,MAAM,WAAW,QACtC,OAAO;CAGT,IAAI,aAAa,CAAC,UAAU,QAAQ,GAClC,OAAO;CAGT,OAAO;AACT;AAEA,SAAgB,sBACd,UACA,SACQ;CAER,QADe,SAAS,kBAAkB,QAAA,CAC5B,QAAQ;AACxB;;;;;;;;;;;AAYA,SAAgB,QAAQ,UAA0C;CAChE,OAAO,KAAK,UAAU,WAAW,GAAG,QAClC,cAAc,GAAG,IACb,OAAO,KAAK,GAAG,CAAC,CACb,KAAK,CAAC,CACN,QAAQ,QAAQ,QAAQ;EACvB,OAAO,OAAO,IAAI;EAClB,OAAO;CACT,GAAG,CAAC,CAAQ,IACd,GACN;AACF;AAMA,SAAgB,gBAAgB,GAAQ,GAAiB;CACvD,IAAI,MAAM,GACR,OAAO;CAGT,IAAI,OAAO,MAAM,OAAO,GACtB,OAAO;CAGT,IAAI,KAAK,KAAK,OAAO,MAAM,YAAY,OAAO,MAAM,UAAU;EAC5D,IAAI,MAAM,QAAQ,CAAC,KAAK,MAAM,QAAQ,CAAC,GAAG;GACxC,IAAI,EAAE,SAAS,EAAE,QAAQ,OAAO;GAChC,KAAK,IAAI,IAAI,GAAG,IAAI,EAAE,QAAQ,KAC5B,IAAI,CAAC,gBAAgB,EAAE,IAAI,EAAE,EAAE,GAC7B,OAAO;GAGX,OAAO;EACT;EAEA,MAAM,QAAQ,OAAO,KAAK,CAAC;EAC3B,KAAK,MAAM,OAAO,OAChB,IAAI,CAAC,gBAAgB,EAAE,MAAM,EAAE,IAAI,GACjC,OAAO;EAGX,OAAO;CACT;CAEA,OAAO;AACT;AAEA,MAAM,SAAS,OAAO,UAAU;AAQhC,SAAgB,iBAAiB,GAAQ,GAAQ,QAAQ,GAAQ;CAC/D,IAAI,MAAM,GACR,OAAO;CAGT,IAAI,QAAQ,KAAK,OAAO;CAExB,MAAM,QAAQ,aAAa,CAAC,KAAK,aAAa,CAAC;CAE/C,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,KAAK,cAAc,CAAC,IAAI,OAAO;CAG9D,MAAM,SADS,QAAQ,IAAI,OAAO,KAAK,CAAC,EAAA,CACnB;CACrB,MAAM,SAAS,QAAQ,IAAI,OAAO,KAAK,CAAC;CACxC,MAAM,QAAQ,OAAO;CACrB,MAAM,OAAY,QAAQ,IAAI,MAAM,KAAK,IAAI,CAAC;CAE9C,IAAI,aAAa;CAEjB,KAAK,IAAI,IAAI,GAAG,IAAI,OAAO,KAAK;EAC9B,MAAM,MAAW,QAAQ,IAAI,OAAO;EACpC,MAAM,QAAQ,EAAE;EAChB,MAAM,QAAQ,EAAE;EAEhB,IAAI,UAAU,OAAO;GACnB,KAAK,OAAO;GACZ,IAAI,QAAQ,IAAI,QAAQ,OAAO,KAAK,GAAG,GAAG,GAAG;GAC7C;EACF;EAEA,IACE,UAAU,QACV,UAAU,QACV,OAAO,UAAU,YACjB,OAAO,UAAU,UACjB;GACA,KAAK,OAAO;GACZ;EACF;EAEA,MAAM,IAAI,iBAAiB,OAAO,OAAO,QAAQ,CAAC;EAClD,KAAK,OAAO;EACZ,IAAI,MAAM,OAAO;CACnB;CAEA,OAAO,UAAU,SAAS,eAAe,QAAQ,IAAI;AACvD;;;;AAKA,SAAgB,oBACd,GACA,GACS;CACT,IAAI,CAAC,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC,WAAW,OAAO,KAAK,CAAC,CAAC,CAAC,QACjD,OAAO;CAGT,KAAK,MAAM,OAAO,GAChB,IAAI,EAAE,SAAS,EAAE,MACf,OAAO;CAIX,OAAO;AACT;AAEA,SAAgB,aAAa,OAAyC;CACpE,OAAO,MAAM,QAAQ,KAAK,KAAK,MAAM,WAAW,OAAO,KAAK,KAAK,CAAC,CAAC;AACrE;AAGA,SAAgB,cAAc,GAA2C;CACvE,IAAI,CAAC,mBAAmB,CAAC,GACvB,OAAO;CAIT,MAAM,OAAO,EAAE;CACf,IAAI,SAAS,KAAA,GACX,OAAO;CAIT,MAAM,OAAO,KAAK;CAClB,IAAI,CAAC,mBAAmB,IAAI,GAC1B,OAAO;CAIT,IAAI,CAAC,KAAK,eAAe,eAAe,GACtC,OAAO;CAIT,IAAI,OAAO,eAAe,CAAC,MAAM,OAAO,WACtC,OAAO;CAIT,OAAO;AACT;AAEA,SAAS,mBAAmB,GAAiB;CAC3C,OAAO,OAAO,UAAU,SAAS,KAAK,CAAC,MAAM;AAC/C;AAEA,SAAgB,MAAM,SAAgC;CACpD,OAAO,IAAI,SAAS,YAAY;EAC9B,eAAe,WAAW,SAAS,OAAO;CAC5C,CAAC;AACH;AAEA,SAAgB,YAGd,UAA6B,MAAa,SAA0B;CACpE,IAAI,OAAO,QAAQ,sBAAsB,YACvC,OAAO,QAAQ,kBAAkB,UAAU,IAAI;MAC1C,IAAI,QAAQ,sBAAsB,OAAO;EAC9C,IAAI,QAAQ,IAAI,aAAa,cAC3B,IAAI;GACF,OAAO,iBAAiB,UAAU,IAAI;EACxC,SAAS,OAAO;GACd,QAAQ,MACN,0JAA0J,QAAQ,UAAU,KAAK,OACnL;GAGA,MAAM;EACR;EAGF,OAAO,iBAAiB,UAAU,IAAI;CACxC;CACA,OAAO;AACT;;;;;;;;;;;;;;;AAgBA,SAAgB,iBACd,cACe;CACf,OAAO;AACT;AAEA,SAAgB,SAAY,OAAiB,MAAS,MAAM,GAAa;CACvE,MAAM,WAAW,CAAC,GAAG,OAAO,IAAI;CAChC,OAAO,OAAO,SAAS,SAAS,MAAM,SAAS,MAAM,CAAC,IAAI;AAC5D;AAEA,SAAgB,WAAc,OAAiB,MAAS,MAAM,GAAa;CACzE,MAAM,WAAW,CAAC,MAAM,GAAG,KAAK;CAChC,OAAO,OAAO,SAAS,SAAS,MAAM,SAAS,MAAM,GAAG,EAAE,IAAI;AAChE;;;;;;;;;;;;;;AAeA,MAAa,YAAY,OAAO;AAMhC,SAAgB,cAId,SAIA,cACwC;CACxC,IAAI,QAAQ,IAAI,aAAa,cACvB;MAAA,QAAQ,YAAY,WACtB,QAAQ,MACN,yGAAyG,QAAQ,UAAU,EAC7H;CAAA;CAOJ,IAAI,CAAC,QAAQ,WAAW,cAAc,gBACpC,aAAa,aAAa;CAG5B,IAAI,CAAC,QAAQ,WAAW,QAAQ,YAAY,WAC1C,aACE,QAAQ,uBAAO,IAAI,MAAM,qBAAqB,QAAQ,UAAU,EAAE,CAAC;CAGvE,OAAO,QAAQ;AACjB;;;;;;;;;;;;;;;;AAiBA,SAAgB,iBACd,cACA,QACS;CAET,IAAI,OAAO,iBAAiB,YAC1B,OAAO,aAAa,GAAG,MAAM;CAG/B,OAAO,CAAC,CAAC;AACX;AAEA,SAAgB,sBACd,QACA,WACA,aAC6B;CAC7B,IAAI,WAAW;CACf,IAAI;CAEJ,OAAO,eAAe,QAAQ,UAAU;EACtC,YAAY;EACZ,WAAW;GACT,WAAW,UAAU;GACrB,IAAI,UACF,OAAO;GAGT,WAAW;GACX,IAAI,OAAO,SACT,YAAY;QAEZ,OAAO,iBAAiB,SAAS,aAAa,EAAE,MAAM,KAAK,CAAC;GAG9D,OAAO;EACT;CACF,CAAC;CAED,OAAO;AACT"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/query-core",
-  "version": "5.102.7",
+  "version": "5.103.0",
   "description": "The framework agnostic core that powers TanStack Query",
   "author": "tannerlinsley",
   "license": "MIT",
@@ -44,16 +44,16 @@
     "@tanstack/query-test-utils": "0.0.0"
   },
   "scripts": {
-    "clean": "premove ./build ./coverage ./dist-ts",
-    "compile": "tsc --build",
+    "clean": "premove ./build ./coverage ./dist-ts ./.cache/test-types",
+    "compile": "tsc --project tsconfig.json",
     "test:eslint": "eslint --concurrency=auto ./src",
     "test:types": "npm-run-all --serial test:types:*",
-    "test:types:ts56": "node ../../node_modules/typescript56/lib/tsc.js --build tsconfig.legacy.json",
-    "test:types:ts57": "node ../../node_modules/typescript57/lib/tsc.js --build tsconfig.legacy.json",
-    "test:types:ts58": "node ../../node_modules/typescript58/lib/tsc.js --build tsconfig.legacy.json",
-    "test:types:ts59": "node ../../node_modules/typescript59/lib/tsc.js --build tsconfig.legacy.json",
-    "test:types:tscurrent": "tsc --build",
-    "test:types:ts70": "node ../../node_modules/typescript70/lib/tsc.js --build tsconfig.legacy.json",
+    "test:types:ts56": "node ../../node_modules/typescript56/lib/tsc.js --project tsconfig.legacy.json --outDir .cache/test-types/ts56 --tsBuildInfoFile .cache/test-types/ts56.tsbuildinfo",
+    "test:types:ts57": "node ../../node_modules/typescript57/lib/tsc.js --project tsconfig.legacy.json --outDir .cache/test-types/ts57 --tsBuildInfoFile .cache/test-types/ts57.tsbuildinfo",
+    "test:types:ts58": "node ../../node_modules/typescript58/lib/tsc.js --project tsconfig.legacy.json --outDir .cache/test-types/ts58 --tsBuildInfoFile .cache/test-types/ts58.tsbuildinfo",
+    "test:types:ts59": "node ../../node_modules/typescript59/lib/tsc.js --project tsconfig.legacy.json --outDir .cache/test-types/ts59 --tsBuildInfoFile .cache/test-types/ts59.tsbuildinfo",
+    "test:types:tscurrent": "tsc --project tsconfig.json --outDir .cache/test-types/tscurrent --tsBuildInfoFile .cache/test-types/tscurrent.tsbuildinfo",
+    "test:types:ts70": "node ../../node_modules/typescript70/lib/tsc.js --project tsconfig.legacy.json --outDir .cache/test-types/ts70 --tsBuildInfoFile .cache/test-types/ts70.tsbuildinfo",
     "test:lib": "vitest",
     "test:lib:dev": "pnpm run test:lib --watch",
     "test:build": "publint --strict && attw --pack",

package/src/environmentManager.ts

@@ -10,7 +10,21 @@ let isServerFn: IsServerValue = () => defaultIsServer
 export const isServer = (): boolean => isServerFn()
 
 /**
- * Manages environment detection used by TanStack Query internals.
+ * Manages how TanStack Query detects whether the current runtime should be treated as
+ * server-side, which disables scheduling refetch timers and changes the default `retry` count
+ * and `gcTime`. By default, the detection treats a missing `window` (or the presence of a
+ * `Deno` global) as server.
+ *
+ * Override this for runtimes where that default detection would give the wrong answer — for
+ * example, a Service Worker, where `window` is undefined even though the environment should
+ * behave like a client.
+ *
+ * @example
+ * ```ts
+ * import { environmentManager } from '@tanstack/query-core'
+ *
+ * environmentManager.setIsServer(() => false)
+ * ```
  */
 export const environmentManager = {
   isServer,

package/src/focusManager.ts

@@ -6,6 +6,11 @@ type SetupFn = (
   setFocused: (focused?: boolean) => void,
 ) => (() => void) | undefined
 
+/**
+ * The `FocusManager` manages the focus state within TanStack Query.
+ *
+ * It can be used to change the default event listeners or to manually change the focus state.
+ */
 export class FocusManager extends Subscribable<Listener> {
   #focused?: boolean
   #cleanup?: () => void
@@ -44,6 +49,31 @@ export class FocusManager extends Subscribable<Listener> {
     }
   }
 
+  /**
+   * `setEventListener` can be used to set a custom event listener that will
+   * be used to determine the focus state. The provided `setup` function
+   * receives a `setFocused` callback: call it with a `boolean` to manually
+   * set the focus state, or with no arguments to re-evaluate the current
+   * focus state and notify subscribers.
+   *
+   * @example
+   * ```ts
+   * import { focusManager } from '@tanstack/query-core'
+   *
+   * focusManager.setEventListener((handleFocus) => {
+   *   const listener = () => handleFocus()
+   *   // Listen to visibilitychange
+   *   if (typeof window !== 'undefined' && window.addEventListener) {
+   *     window.addEventListener('visibilitychange', listener, false)
+   *   }
+   *
+   *   return () => {
+   *     // Be sure to unsubscribe if a new handler is set
+   *     window.removeEventListener('visibilitychange', listener)
+   *   }
+   * })
+   * ```
+   */
   setEventListener(setup: SetupFn): void {
     this.#setup = setup
     this.#cleanup?.()
@@ -56,6 +86,24 @@ export class FocusManager extends Subscribable<Listener> {
     })
   }
 
+  /**
+   * `setFocused` can be used to manually set the focus state. Set `undefined`
+   * to fall back to the default focus check.
+   *
+   * @example
+   * ```ts
+   * import { focusManager } from '@tanstack/query-core'
+   *
+   * // Set focused
+   * focusManager.setFocused(true)
+   *
+   * // Set unfocused
+   * focusManager.setFocused(false)
+   *
+   * // Fallback to the default focus check
+   * focusManager.setFocused(undefined)
+   * ```
+   */
   setFocused(focused?: boolean): void {
     const changed = this.#focused !== focused
     if (changed) {
@@ -64,6 +112,9 @@ export class FocusManager extends Subscribable<Listener> {
     }
   }
 
+  /**
+   * `onFocus` notifies all subscribed listeners with the current focus state.
+   */
   onFocus(): void {
     const isFocused = this.isFocused()
     this.listeners.forEach((listener) => {
@@ -71,6 +122,9 @@ export class FocusManager extends Subscribable<Listener> {
     })
   }
 
+  /**
+   * `isFocused` can be used to get the current focus state.
+   */
   isFocused(): boolean {
     if (typeof this.#focused === 'boolean') {
       return this.#focused
@@ -82,4 +136,7 @@ export class FocusManager extends Subscribable<Listener> {
   }
 }
 
+/**
+ * Singleton instance of {@link FocusManager}, used to manage and observe the focus state within TanStack Query.
+ */
 export const focusManager = new FocusManager()

package/src/hydration.ts

@@ -35,17 +35,36 @@ function tryResolveSync(promise: PromiseLike<unknown>) {
   return undefined
 }
 
+/**
+ * Options for `dehydrate`, controlling which queries/mutations are included in the resulting `DehydratedState` and
+ * how their data/errors are transformed before being serialized (e.g. for embedding in server-rendered markup).
+ */
 export interface DehydrateOptions {
+  /** Transforms a query's `data` before it is dehydrated. Useful for non-JSON-serializable data. */
   serializeData?: TransformerFn
+  /** Predicate to decide whether a given `Mutation` should be dehydrated. Defaults to `defaultShouldDehydrateMutation`. */
   shouldDehydrateMutation?: (mutation: Mutation) => boolean
+  /** Predicate to decide whether a given `Query` should be dehydrated. Defaults to `defaultShouldDehydrateQuery`. */
   shouldDehydrateQuery?: (query: Query) => boolean
+  /**
+   * Predicate to decide whether a query's error should be redacted before dehydration. Errors are redacted
+   * (replaced with a generic `Error('redacted')`) unless this function is provided and returns `false` for the
+   * given error, in which case the original error is kept.
+   */
   shouldRedactErrors?: (error: unknown) => boolean
 }
 
+/**
+ * Options for `hydrate`, controlling the default options applied to queries/mutations restored from a
+ * `DehydratedState`, and how to reverse any transformation applied by `DehydrateOptions.serializeData`.
+ */
 export interface HydrateOptions {
   defaultOptions?: {
+    /** Transforms a query's `data` after it is read from the dehydrated state, reversing `serializeData`. */
     deserializeData?: TransformerFn
+    /** Default options merged into every query restored from the dehydrated state. */
     queries?: QueryOptions
+    /** Default options merged into every mutation restored from the dehydrated state. */
     mutations?: MutationOptions<unknown, DefaultError, unknown, unknown>
   }
 }
@@ -61,15 +80,17 @@ interface DehydratedQuery {
   queryHash: string
   queryKey: QueryKey
   state: QueryState
+  dehydratedAt: number
   promise?: Promise<unknown>
   meta?: QueryMeta
   queryType?: 'infinite'
-  // This is only optional because older versions of Query might have dehydrated
-  // without it which we need to handle for backwards compatibility.
-  // This should be changed to required in the future.
-  dehydratedAt?: number
 }
 
+/**
+ * A serializable snapshot of a `QueryClient`'s cache, as produced by `dehydrate` and consumed by `hydrate`. Typically
+ * transported from server to client (e.g. embedded in server-rendered markup) to seed the client's cache with data
+ * that has already been fetched, avoiding a redundant fetch on the client.
+ */
 export interface DehydratedState {
   mutations: Array<DehydratedMutation>
   queries: Array<DehydratedQuery>
@@ -114,10 +135,16 @@ function dehydratePromise(
   return promise
 }
 
-// Most config is not dehydrated but instead meant to configure again when
-// consuming the de/rehydrated data, typically with useQuery on the client.
-// Sometimes it might make sense to prefetch data on the server and include
-// in the html-payload, but not consume it on the initial render.
+/**
+ * Dehydrates a single `Query` into a serializable `DehydratedQuery` snapshot. Note that most query config (e.g.
+ * `queryFn`, `staleTime`) is not dehydrated but instead meant to be configured again when consuming the
+ * de/rehydrated data, typically with `useQuery` on the client. If the query is still `pending`, its in-flight
+ * promise is dehydrated too so it can be resumed on the other side instead of re-fetched.
+ * @param query - The query to dehydrate.
+ * @param serializeData - Optional transform applied to `query.state.data` before it is included in the snapshot.
+ * @param shouldRedactErrors - Optional predicate; if it returns `false` for the promise's rejection error, that
+ * error is kept as-is instead of being redacted.
+ */
 export function dehydrateQuery(
   query: Query,
   serializeData?: TransformerFn,
@@ -143,14 +170,40 @@ export function dehydrateQuery(
   }
 }
 
+/**
+ * The default `shouldDehydrateMutation` predicate used by `dehydrate`. Only dehydrates mutations that are
+ * currently paused (e.g. paused by `networkMode` while offline).
+ */
 export function defaultShouldDehydrateMutation(mutation: Mutation) {
   return mutation.state.isPaused
 }
 
+/**
+ * The default `shouldDehydrateQuery` predicate used by `dehydrate`. Only dehydrates queries whose status is
+ * `'success'`.
+ */
 export function defaultShouldDehydrateQuery(query: Query) {
   return query.state.status === 'success'
 }
 
+/**
+ * Dehydrates a `QueryClient`'s cache (queries and mutations) into a plain, serializable `DehydratedState`,
+ * typically to embed in server-rendered markup and later restore into a client-side `QueryClient` via `hydrate`.
+ * Which queries/mutations are included, and how their data/errors are transformed, is controlled by `options`,
+ * falling back to the client's `dehydrate` default options, and finally to `defaultShouldDehydrateQuery` /
+ * `defaultShouldDehydrateMutation`.
+ * @example
+ * ```ts
+ * const queryClient = new QueryClient()
+ *
+ * await queryClient.prefetchQuery({
+ *   queryKey: ['posts'],
+ *   queryFn: getPosts,
+ * })
+ *
+ * const dehydratedState = dehydrate(queryClient)
+ * ```
+ */
 export function dehydrate(
   client: QueryClient,
   options: DehydrateOptions = {},
@@ -191,6 +244,23 @@ export function dehydrate(
   return { mutations, queries }
 }
 
+/**
+ * Restores a `DehydratedState` (as produced by `dehydrate`) into a `QueryClient`'s cache, typically to seed the
+ * client with data already fetched on the server. `mutations` and `queries` are each optional on `dehydratedState`.
+ * Queries not yet in the cache are built from the dehydrated snapshot; queries that already exist are only updated
+ * when the dehydrated data is newer than what's already cached. Newly built queries have their `fetchStatus` reset
+ * to `'idle'` so they don't hydrate stuck in a fetching state. If a dehydrated query still had an in-flight
+ * promise, it is resumed via `query.fetch()` (reusing that promise as `initialPromise`) rather than re-invoking
+ * `queryFn`.
+ * @example
+ * ```ts
+ * // dehydratedState was produced by `dehydrate` on the server
+ * // and sent to the client, e.g. embedded in server-rendered markup.
+ * const queryClient = new QueryClient()
+ *
+ * hydrate(queryClient, dehydratedState)
+ * ```
+ */
 export function hydrate(
   client: QueryClient,
   dehydratedState: Partial<DehydratedState>,
@@ -240,11 +310,7 @@ export function hydrate(
       // Do not hydrate if an existing query exists with newer data
       if (query) {
         const hasNewerSyncData =
-          syncData &&
-          // We only need this undefined check to handle older dehydration
-          // payloads that might not have dehydratedAt
-          dehydratedAt !== undefined &&
-          dehydratedAt > query.state.dataUpdatedAt
+          syncData && dehydratedAt > query.state.dataUpdatedAt
         if (
           state.dataUpdatedAt > query.state.dataUpdatedAt ||
           hasNewerSyncData
@@ -262,7 +328,7 @@ export function hydrate(
             ...(state.status === 'pending' &&
               data !== undefined && {
                 status: 'success' as const,
-                dataUpdatedAt: dehydratedAt ?? Date.now(),
+                dataUpdatedAt: dehydratedAt,
                 // Preserve existing fetchStatus if the existing query is actively fetching.
                 ...(!existingQueryIsFetching && {
                   fetchStatus: 'idle' as const,
@@ -296,7 +362,7 @@ export function hydrate(
                 : state.status,
             ...(state.status === 'pending' &&
               data !== undefined && {
-                dataUpdatedAt: dehydratedAt ?? Date.now(),
+                dataUpdatedAt: dehydratedAt,
               }),
           },
         )
@@ -311,7 +377,7 @@ export function hydrate(
         !existingQueryIsFetching &&
         // Only hydrate if dehydration is newer than any existing data,
         // this is always true for new queries
-        (dehydratedAt === undefined || dehydratedAt > query.state.dataUpdatedAt)
+        dehydratedAt > query.state.dataUpdatedAt
       ) {
         // This doesn't actually fetch - it just creates a retryer
         // which will re-use the passed `initialPromise`

package/src/index.ts

@@ -1,6 +1,7 @@
 /* istanbul ignore file */
 
 export { focusManager } from './focusManager'
+export type { FocusManager } from './focusManager'
 export { environmentManager } from './environmentManager'
 export {
   defaultShouldDehydrateMutation,
@@ -15,6 +16,7 @@ export type { MutationCacheNotifyEvent } from './mutationCache'
 export { MutationObserver } from './mutationObserver'
 export { defaultScheduler, notifyManager } from './notifyManager'
 export { onlineManager } from './onlineManager'
+export type { OnlineManager } from './onlineManager'
 export { QueriesObserver } from './queriesObserver'
 export { QueryCache } from './queryCache'
 export type { QueryCacheNotifyEvent } from './queryCache'
@@ -25,6 +27,7 @@ export {
   timeoutManager,
   type ManagedTimerId,
   type TimeoutCallback,
+  type TimeoutManager,
   type TimeoutProvider,
 } from './timeoutManager'
 export {

package/src/infiniteQueryObserver.ts

@@ -19,6 +19,25 @@ type InfiniteQueryObserverListener<TData, TError> = (
   result: InfiniteQueryObserverResult<TData, TError>,
 ) => void
 
+/**
+ * An `InfiniteQueryObserver` extends `QueryObserver` to observe and switch
+ * between infinite queries. It augments the base `QueryObserverResult` with
+ * infinite-query-specific fields and methods, such as `hasNextPage` and
+ * `fetchNextPage`, and is the primitive that framework adapters (e.g.
+ * `useInfiniteQuery`) build their hooks on top of.
+ *
+ * @example
+ * ```ts
+ * const observer = new InfiniteQueryObserver(queryClient, {
+ *   queryKey: ['projects'],
+ *   queryFn: ({ pageParam }) => fetchProjects(pageParam),
+ *   initialPageParam: 0,
+ *   getNextPageParam: (lastPage) => lastPage.nextCursor,
+ * })
+ *
+ * const unsubscribe = observer.subscribe((result) => console.log(result))
+ * ```
+ */
 export class InfiniteQueryObserver<
   TQueryFnData = unknown,
   TError = DefaultError,
@@ -80,6 +99,12 @@ export class InfiniteQueryObserver<
     this.fetchPreviousPage = this.fetchPreviousPage.bind(this)
   }
 
+  /**
+   * Updates the observer's options. Behaves the same as
+   * `QueryObserver.setOptions`, additionally marking the options as
+   * belonging to an infinite query before delegating to the base
+   * implementation.
+   */
   setOptions(
     options: InfiniteQueryObserverOptions<
       TQueryFnData,
@@ -93,6 +118,12 @@ export class InfiniteQueryObserver<
     super.setOptions(options)
   }
 
+  /**
+   * The infinite-query counterpart of {@link QueryObserver#getOptimisticResult}, marking the
+   * options as an infinite query before delegating to it. Called by framework adapters (e.g.
+   * `useInfiniteQuery`) ahead of subscribing, to compute the current `InfiniteQueryObserverResult`
+   * synchronously.
+   */
   getOptimisticResult(
     options: DefaultedInfiniteQueryObserverOptions<
       TQueryFnData,
@@ -109,6 +140,24 @@ export class InfiniteQueryObserver<
     >
   }
 
+  /**
+   * Fetches the next page of the infinite query and returns a promise that
+   * resolves with the resulting `InfiniteQueryObserverResult`. The page
+   * param used for the fetch is determined by `getNextPageParam`, which
+   * receives the current pages/page params and whose result also determines
+   * `hasNextPage`.
+   *
+   * @example
+   * ```ts
+   * const { hasNextPage } = observer.getCurrentResult()
+   *
+   * if (hasNextPage) {
+   *   await observer.fetchNextPage()
+   * }
+   * ```
+   *
+   * @see {@link InfiniteQueryObserver#fetchPreviousPage}
+   */
   fetchNextPage(
     options?: FetchNextPageOptions,
   ): Promise<InfiniteQueryObserverResult<TData, TError>> {
@@ -120,6 +169,24 @@ export class InfiniteQueryObserver<
     })
   }
 
+  /**
+   * Fetches the previous page of the infinite query and returns a promise
+   * that resolves with the resulting `InfiniteQueryObserverResult`. The page
+   * param used for the fetch is determined by `getPreviousPageParam`, which
+   * receives the current pages/page params and whose result also determines
+   * `hasPreviousPage`.
+   *
+   * @example
+   * ```ts
+   * const { hasPreviousPage } = observer.getCurrentResult()
+   *
+   * if (hasPreviousPage) {
+   *   await observer.fetchPreviousPage()
+   * }
+   * ```
+   *
+   * @see {@link InfiniteQueryObserver#fetchNextPage}
+   */
   fetchPreviousPage(
     options?: FetchPreviousPageOptions,
   ): Promise<InfiniteQueryObserverResult<TData, TError>> {