@tanstack/query-core 5.102.7 → 5.103.0

package/build/modern/notifyManager.d.cts

@@ -4,13 +4,27 @@ type NotifyFunction = (callback: () => void) => void;
 type BatchNotifyFunction = (callback: () => void) => void;
 type BatchCallsCallback<T extends Array<unknown>> = (...args: T) => void;
 type ScheduleFunction = (callback: () => void) => void;
+/**
+ * Default scheduling function used by the notify manager.
+ * Schedules the callback with the system's `setTimeout(callback, 0)`.
+ */
 declare const defaultScheduler: ScheduleFunction;
 declare function createNotifyManager(): {
+  /**
+   * Batches all updates scheduled inside the passed callback.
+   * This is mainly used internally to optimize query client updating.
+   * Batches can be nested; the queue is only flushed once the outermost `batch` call finishes.
+   * The return value of `callback` is passed through.
+   */
   readonly batch: <T>(callback: () => T) => T;
   /**
    * All calls to the wrapped function will be batched.
    */
   readonly batchCalls: <T extends Array<unknown>>(callback: BatchCallsCallback<T>) => BatchCallsCallback<T>;
+  /**
+   * Schedules a function to be run on the next batch.
+   * By default, the batch is run with a `setTimeout`, but this can be configured via `setScheduler`.
+   */
   readonly schedule: (callback: NotifyCallback) => void;
   /**
    * Use this method to set a custom notify function.
@@ -19,17 +33,57 @@ declare function createNotifyManager(): {
   readonly setNotifyFunction: (fn: NotifyFunction) => void;
   /**
    * Use this method to set a custom function to batch notifications together into a single tick.
-   * By default React Query will use the batch function provided by ReactDOM or React Native.
+   * Framework adapters use this to plug in their own batching primitive, so that a single query
+   * update only triggers one re-render instead of one per subscriber.
+   *
+   * @example
+   * ```ts
+   * import { notifyManager } from '@tanstack/query-core'
+   * import { batch } from 'solid-js'
+   *
+   * notifyManager.setBatchNotifyFunction(batch)
+   * ```
    */
   readonly setBatchNotifyFunction: (fn: BatchNotifyFunction) => void;
+  /**
+   * Configures a custom callback that schedules when the next batch runs.
+   * The default behavior is `setTimeout(callback, 0)`.
+   *
+   * @example
+   * ```ts
+   * import { notifyManager } from '@tanstack/query-core'
+   *
+   * // Schedule batches in the next microtask
+   * notifyManager.setScheduler(queueMicrotask)
+   *
+   * // Schedule batches before the next frame is rendered
+   * notifyManager.setScheduler(requestAnimationFrame)
+   *
+   * // Schedule batches some time in the future
+   * notifyManager.setScheduler((cb) => setTimeout(cb, 10))
+   * ```
+   */
   readonly setScheduler: (fn: ScheduleFunction) => void;
 };
+/**
+ * Handles scheduling and batching callbacks in TanStack Query.
+ */
 declare const notifyManager: {
+  /**
+   * Batches all updates scheduled inside the passed callback.
+   * This is mainly used internally to optimize query client updating.
+   * Batches can be nested; the queue is only flushed once the outermost `batch` call finishes.
+   * The return value of `callback` is passed through.
+   */
   readonly batch: <T>(callback: () => T) => T;
   /**
    * All calls to the wrapped function will be batched.
    */
   readonly batchCalls: <T extends Array<unknown>>(callback: BatchCallsCallback<T>) => BatchCallsCallback<T>;
+  /**
+   * Schedules a function to be run on the next batch.
+   * By default, the batch is run with a `setTimeout`, but this can be configured via `setScheduler`.
+   */
   readonly schedule: (callback: NotifyCallback) => void;
   /**
    * Use this method to set a custom notify function.
@@ -38,9 +92,36 @@ declare const notifyManager: {
   readonly setNotifyFunction: (fn: NotifyFunction) => void;
   /**
    * Use this method to set a custom function to batch notifications together into a single tick.
-   * By default React Query will use the batch function provided by ReactDOM or React Native.
+   * Framework adapters use this to plug in their own batching primitive, so that a single query
+   * update only triggers one re-render instead of one per subscriber.
+   *
+   * @example
+   * ```ts
+   * import { notifyManager } from '@tanstack/query-core'
+   * import { batch } from 'solid-js'
+   *
+   * notifyManager.setBatchNotifyFunction(batch)
+   * ```
    */
   readonly setBatchNotifyFunction: (fn: BatchNotifyFunction) => void;
+  /**
+   * Configures a custom callback that schedules when the next batch runs.
+   * The default behavior is `setTimeout(callback, 0)`.
+   *
+   * @example
+   * ```ts
+   * import { notifyManager } from '@tanstack/query-core'
+   *
+   * // Schedule batches in the next microtask
+   * notifyManager.setScheduler(queueMicrotask)
+   *
+   * // Schedule batches before the next frame is rendered
+   * notifyManager.setScheduler(requestAnimationFrame)
+   *
+   * // Schedule batches some time in the future
+   * notifyManager.setScheduler((cb) => setTimeout(cb, 10))
+   * ```
+   */
   readonly setScheduler: (fn: ScheduleFunction) => void;
 };
 //#endregion

package/build/modern/notifyManager.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"notifyManager.d.cts","names":[],"sources":["../../src/notifyManager.ts"],"mappings":";KAIK;KAEA,kBAAkB;KAElB,uBAAuB;KAEvB,mBAAmB,UAAU,sBAAsB,MAAM;KAEzD,oBAAoB;cAEZ,kBAAkB;iBAEf;WAmCJ,QAAA,GAAC,gBAAkB,MAAI;;;;WAgBlB,aAAA,UAAU,gBAAc,UACzB,mBAAmB,OAC5B,mBAAmB;WA1CI,WAAA,UAAA;;;;;WAsDF,oBAAA,IAAA;;;;;WAOK,yBAAA,IAAA;WAGV,eAAA,IAAA;;cAOV;WA/CD,QAAA,GAAC,gBAAkB,MAAI;;;;WAgBlB,aAAA,UAAU,gBAAc,UACzB,mBAAmB,OAC5B,mBAAmB;WA1CI,WAAA,UAAA;;;;;WAsDF,oBAAA,IAAA;;;;;WAOK,yBAAA,IAAA;WAGV,eAAA,IAAA"}
+{"version":3,"file":"notifyManager.d.cts","names":[],"sources":["../../src/notifyManager.ts"],"mappings":";KAIK;KAEA,kBAAkB;KAElB,uBAAuB;KAEvB,mBAAmB,UAAU,sBAAsB,MAAM;KAEzD,oBAAoB;;;;;cAMZ,kBAAkB;iBAEf;;;;;;;WAyCJ,QAAA,GAAC,gBAAkB,MAAI;;;;WAgBlB,aAAA,UAAU,gBAAc,UACzB,mBAAmB,OAC5B,mBAAmB;;;;;WAhDI,WAAA,UAAA;;;;;WAgEF,oBAAA,IAAA;;;;;;;;;;;;;;WAgBK,yBAAA,IAAA;;;;;;;;;;;;;;;;;;;WAqBV,eAAA,IAAA;;;;;cAWV;;;;;;;WAlFD,QAAA,GAAC,gBAAkB,MAAI;;;;WAgBlB,aAAA,UAAU,gBAAc,UACzB,mBAAmB,OAC5B,mBAAmB;;;;;WAhDI,WAAA,UAAA;;;;;WAgEF,oBAAA,IAAA;;;;;;;;;;;;;;WAgBK,yBAAA,IAAA;;;;;;;;;;;;;;;;;;;WAqBV,eAAA,IAAA"}

package/build/modern/notifyManager.d.ts

@@ -4,13 +4,27 @@ type NotifyFunction = (callback: () => void) => void;
 type BatchNotifyFunction = (callback: () => void) => void;
 type BatchCallsCallback<T extends Array<unknown>> = (...args: T) => void;
 type ScheduleFunction = (callback: () => void) => void;
+/**
+ * Default scheduling function used by the notify manager.
+ * Schedules the callback with the system's `setTimeout(callback, 0)`.
+ */
 declare const defaultScheduler: ScheduleFunction;
 declare function createNotifyManager(): {
+  /**
+   * Batches all updates scheduled inside the passed callback.
+   * This is mainly used internally to optimize query client updating.
+   * Batches can be nested; the queue is only flushed once the outermost `batch` call finishes.
+   * The return value of `callback` is passed through.
+   */
   readonly batch: <T>(callback: () => T) => T;
   /**
    * All calls to the wrapped function will be batched.
    */
   readonly batchCalls: <T extends Array<unknown>>(callback: BatchCallsCallback<T>) => BatchCallsCallback<T>;
+  /**
+   * Schedules a function to be run on the next batch.
+   * By default, the batch is run with a `setTimeout`, but this can be configured via `setScheduler`.
+   */
   readonly schedule: (callback: NotifyCallback) => void;
   /**
    * Use this method to set a custom notify function.
@@ -19,17 +33,57 @@ declare function createNotifyManager(): {
   readonly setNotifyFunction: (fn: NotifyFunction) => void;
   /**
    * Use this method to set a custom function to batch notifications together into a single tick.
-   * By default React Query will use the batch function provided by ReactDOM or React Native.
+   * Framework adapters use this to plug in their own batching primitive, so that a single query
+   * update only triggers one re-render instead of one per subscriber.
+   *
+   * @example
+   * ```ts
+   * import { notifyManager } from '@tanstack/query-core'
+   * import { batch } from 'solid-js'
+   *
+   * notifyManager.setBatchNotifyFunction(batch)
+   * ```
    */
   readonly setBatchNotifyFunction: (fn: BatchNotifyFunction) => void;
+  /**
+   * Configures a custom callback that schedules when the next batch runs.
+   * The default behavior is `setTimeout(callback, 0)`.
+   *
+   * @example
+   * ```ts
+   * import { notifyManager } from '@tanstack/query-core'
+   *
+   * // Schedule batches in the next microtask
+   * notifyManager.setScheduler(queueMicrotask)
+   *
+   * // Schedule batches before the next frame is rendered
+   * notifyManager.setScheduler(requestAnimationFrame)
+   *
+   * // Schedule batches some time in the future
+   * notifyManager.setScheduler((cb) => setTimeout(cb, 10))
+   * ```
+   */
   readonly setScheduler: (fn: ScheduleFunction) => void;
 };
+/**
+ * Handles scheduling and batching callbacks in TanStack Query.
+ */
 declare const notifyManager: {
+  /**
+   * Batches all updates scheduled inside the passed callback.
+   * This is mainly used internally to optimize query client updating.
+   * Batches can be nested; the queue is only flushed once the outermost `batch` call finishes.
+   * The return value of `callback` is passed through.
+   */
   readonly batch: <T>(callback: () => T) => T;
   /**
    * All calls to the wrapped function will be batched.
    */
   readonly batchCalls: <T extends Array<unknown>>(callback: BatchCallsCallback<T>) => BatchCallsCallback<T>;
+  /**
+   * Schedules a function to be run on the next batch.
+   * By default, the batch is run with a `setTimeout`, but this can be configured via `setScheduler`.
+   */
   readonly schedule: (callback: NotifyCallback) => void;
   /**
    * Use this method to set a custom notify function.
@@ -38,9 +92,36 @@ declare const notifyManager: {
   readonly setNotifyFunction: (fn: NotifyFunction) => void;
   /**
    * Use this method to set a custom function to batch notifications together into a single tick.
-   * By default React Query will use the batch function provided by ReactDOM or React Native.
+   * Framework adapters use this to plug in their own batching primitive, so that a single query
+   * update only triggers one re-render instead of one per subscriber.
+   *
+   * @example
+   * ```ts
+   * import { notifyManager } from '@tanstack/query-core'
+   * import { batch } from 'solid-js'
+   *
+   * notifyManager.setBatchNotifyFunction(batch)
+   * ```
    */
   readonly setBatchNotifyFunction: (fn: BatchNotifyFunction) => void;
+  /**
+   * Configures a custom callback that schedules when the next batch runs.
+   * The default behavior is `setTimeout(callback, 0)`.
+   *
+   * @example
+   * ```ts
+   * import { notifyManager } from '@tanstack/query-core'
+   *
+   * // Schedule batches in the next microtask
+   * notifyManager.setScheduler(queueMicrotask)
+   *
+   * // Schedule batches before the next frame is rendered
+   * notifyManager.setScheduler(requestAnimationFrame)
+   *
+   * // Schedule batches some time in the future
+   * notifyManager.setScheduler((cb) => setTimeout(cb, 10))
+   * ```
+   */
   readonly setScheduler: (fn: ScheduleFunction) => void;
 };
 //#endregion

package/build/modern/notifyManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"notifyManager.d.ts","names":[],"sources":["../../src/notifyManager.ts"],"mappings":";KAIK;KAEA,kBAAkB;KAElB,uBAAuB;KAEvB,mBAAmB,UAAU,sBAAsB,MAAM;KAEzD,oBAAoB;cAEZ,kBAAkB;iBAEf;WAmCJ,QAAA,GAAC,gBAAkB,MAAI;;;;WAgBlB,aAAA,UAAU,gBAAc,UACzB,mBAAmB,OAC5B,mBAAmB;WA1CI,WAAA,UAAA;;;;;WAsDF,oBAAA,IAAA;;;;;WAOK,yBAAA,IAAA;WAGV,eAAA,IAAA;;cAOV;WA/CD,QAAA,GAAC,gBAAkB,MAAI;;;;WAgBlB,aAAA,UAAU,gBAAc,UACzB,mBAAmB,OAC5B,mBAAmB;WA1CI,WAAA,UAAA;;;;;WAsDF,oBAAA,IAAA;;;;;WAOK,yBAAA,IAAA;WAGV,eAAA,IAAA"}
+{"version":3,"file":"notifyManager.d.ts","names":[],"sources":["../../src/notifyManager.ts"],"mappings":";KAIK;KAEA,kBAAkB;KAElB,uBAAuB;KAEvB,mBAAmB,UAAU,sBAAsB,MAAM;KAEzD,oBAAoB;;;;;cAMZ,kBAAkB;iBAEf;;;;;;;WAyCJ,QAAA,GAAC,gBAAkB,MAAI;;;;WAgBlB,aAAA,UAAU,gBAAc,UACzB,mBAAmB,OAC5B,mBAAmB;;;;;WAhDI,WAAA,UAAA;;;;;WAgEF,oBAAA,IAAA;;;;;;;;;;;;;;WAgBK,yBAAA,IAAA;;;;;;;;;;;;;;;;;;;WAqBV,eAAA,IAAA;;;;;cAWV;;;;;;;WAlFD,QAAA,GAAC,gBAAkB,MAAI;;;;WAgBlB,aAAA,UAAU,gBAAc,UACzB,mBAAmB,OAC5B,mBAAmB;;;;;WAhDI,WAAA,UAAA;;;;;WAgEF,oBAAA,IAAA;;;;;;;;;;;;;;WAgBK,yBAAA,IAAA;;;;;;;;;;;;;;;;;;;WAqBV,eAAA,IAAA"}

package/build/modern/notifyManager.js

@@ -1,5 +1,9 @@
 import { systemSetTimeoutZero } from "./timeoutManager.js";
 //#region src/notifyManager.ts
+/**
+* Default scheduling function used by the notify manager.
+* Schedules the callback with the system's `setTimeout(callback, 0)`.
+*/
 const defaultScheduler = systemSetTimeoutZero;
 function createNotifyManager() {
 	let queue = [];
@@ -29,6 +33,12 @@ function createNotifyManager() {
 		});
 	};
 	return {
+		/**
+		* Batches all updates scheduled inside the passed callback.
+		* This is mainly used internally to optimize query client updating.
+		* Batches can be nested; the queue is only flushed once the outermost `batch` call finishes.
+		* The return value of `callback` is passed through.
+		*/
 		batch: (callback) => {
 			let result;
 			transactions++;
@@ -50,6 +60,10 @@ function createNotifyManager() {
 				});
 			};
 		},
+		/**
+		* Schedules a function to be run on the next batch.
+		* By default, the batch is run with a `setTimeout`, but this can be configured via `setScheduler`.
+		*/
 		schedule,
 		/**
 		* Use this method to set a custom notify function.
@@ -60,16 +74,46 @@ function createNotifyManager() {
 		},
 		/**
 		* Use this method to set a custom function to batch notifications together into a single tick.
-		* By default React Query will use the batch function provided by ReactDOM or React Native.
+		* Framework adapters use this to plug in their own batching primitive, so that a single query
+		* update only triggers one re-render instead of one per subscriber.
+		*
+		* @example
+		* ```ts
+		* import { notifyManager } from '@tanstack/query-core'
+		* import { batch } from 'solid-js'
+		*
+		* notifyManager.setBatchNotifyFunction(batch)
+		* ```
 		*/
 		setBatchNotifyFunction: (fn) => {
 			batchNotifyFn = fn;
 		},
+		/**
+		* Configures a custom callback that schedules when the next batch runs.
+		* The default behavior is `setTimeout(callback, 0)`.
+		*
+		* @example
+		* ```ts
+		* import { notifyManager } from '@tanstack/query-core'
+		*
+		* // Schedule batches in the next microtask
+		* notifyManager.setScheduler(queueMicrotask)
+		*
+		* // Schedule batches before the next frame is rendered
+		* notifyManager.setScheduler(requestAnimationFrame)
+		*
+		* // Schedule batches some time in the future
+		* notifyManager.setScheduler((cb) => setTimeout(cb, 10))
+		* ```
+		*/
 		setScheduler: (fn) => {
 			scheduleFn = fn;
 		}
 	};
 }
+/**
+* Handles scheduling and batching callbacks in TanStack Query.
+*/
 const notifyManager = createNotifyManager();
 //#endregion
 export { createNotifyManager, defaultScheduler, notifyManager };

package/build/modern/notifyManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"notifyManager.js","names":[],"sources":["../../src/notifyManager.ts"],"sourcesContent":["// TYPES\n\nimport { systemSetTimeoutZero } from './timeoutManager'\n\ntype NotifyCallback = () => void\n\ntype NotifyFunction = (callback: () => void) => void\n\ntype BatchNotifyFunction = (callback: () => void) => void\n\ntype BatchCallsCallback<T extends Array<unknown>> = (...args: T) => void\n\ntype ScheduleFunction = (callback: () => void) => void\n\nexport const defaultScheduler: ScheduleFunction = systemSetTimeoutZero\n\nexport function createNotifyManager() {\n  let queue: Array<NotifyCallback> = []\n  let transactions = 0\n  let notifyFn: NotifyFunction = (callback) => {\n    callback()\n  }\n  let batchNotifyFn: BatchNotifyFunction = (callback: () => void) => {\n    callback()\n  }\n  let scheduleFn = defaultScheduler\n\n  const schedule = (callback: NotifyCallback): void => {\n    if (transactions) {\n      queue.push(callback)\n    } else {\n      scheduleFn(() => {\n        notifyFn(callback)\n      })\n    }\n  }\n  const flush = (): void => {\n    const originalQueue = queue\n    queue = []\n    if (originalQueue.length) {\n      scheduleFn(() => {\n        batchNotifyFn(() => {\n          originalQueue.forEach((callback) => {\n            notifyFn(callback)\n          })\n        })\n      })\n    }\n  }\n\n  return {\n    batch: <T>(callback: () => T): T => {\n      let result\n      transactions++\n      try {\n        result = callback()\n      } finally {\n        transactions--\n        if (!transactions) {\n          flush()\n        }\n      }\n      return result\n    },\n    /**\n     * All calls to the wrapped function will be batched.\n     */\n    batchCalls: <T extends Array<unknown>>(\n      callback: BatchCallsCallback<T>,\n    ): BatchCallsCallback<T> => {\n      return (...args) => {\n        schedule(() => {\n          callback(...args)\n        })\n      }\n    },\n    schedule,\n    /**\n     * Use this method to set a custom notify function.\n     * This can be used to for example wrap notifications with `React.act` while running tests.\n     */\n    setNotifyFunction: (fn: NotifyFunction) => {\n      notifyFn = fn\n    },\n    /**\n     * Use this method to set a custom function to batch notifications together into a single tick.\n     * By default React Query will use the batch function provided by ReactDOM or React Native.\n     */\n    setBatchNotifyFunction: (fn: BatchNotifyFunction) => {\n      batchNotifyFn = fn\n    },\n    setScheduler: (fn: ScheduleFunction) => {\n      scheduleFn = fn\n    },\n  } as const\n}\n\n// SINGLETON\nexport const notifyManager = createNotifyManager()\n"],"mappings":";;AAcA,MAAa,mBAAqC;AAElD,SAAgB,sBAAsB;CACpC,IAAI,QAA+B,CAAC;CACpC,IAAI,eAAe;CACnB,IAAI,YAA4B,aAAa;EAC3C,SAAS;CACX;CACA,IAAI,iBAAsC,aAAyB;EACjE,SAAS;CACX;CACA,IAAI,aAAa;CAEjB,MAAM,YAAY,aAAmC;EACnD,IAAI,cACF,MAAM,KAAK,QAAQ;OAEnB,iBAAiB;GACf,SAAS,QAAQ;EACnB,CAAC;CAEL;CACA,MAAM,cAAoB;EACxB,MAAM,gBAAgB;EACtB,QAAQ,CAAC;EACT,IAAI,cAAc,QAChB,iBAAiB;GACf,oBAAoB;IAClB,cAAc,SAAS,aAAa;KAClC,SAAS,QAAQ;IACnB,CAAC;GACH,CAAC;EACH,CAAC;CAEL;CAEA,OAAO;EACL,QAAW,aAAyB;GAClC,IAAI;GACJ;GACA,IAAI;IACF,SAAS,SAAS;GACpB,UAAU;IACR;IACA,IAAI,CAAC,cACH,MAAM;GAEV;GACA,OAAO;EACT;;;;EAIA,aACE,aAC0B;GAC1B,QAAQ,GAAG,SAAS;IAClB,eAAe;KACb,SAAS,GAAG,IAAI;IAClB,CAAC;GACH;EACF;EACA;;;;;EAKA,oBAAoB,OAAuB;GACzC,WAAW;EACb;;;;;EAKA,yBAAyB,OAA4B;GACnD,gBAAgB;EAClB;EACA,eAAe,OAAyB;GACtC,aAAa;EACf;CACF;AACF;AAGA,MAAa,gBAAgB,oBAAoB"}
+{"version":3,"file":"notifyManager.js","names":[],"sources":["../../src/notifyManager.ts"],"sourcesContent":["// TYPES\n\nimport { systemSetTimeoutZero } from './timeoutManager'\n\ntype NotifyCallback = () => void\n\ntype NotifyFunction = (callback: () => void) => void\n\ntype BatchNotifyFunction = (callback: () => void) => void\n\ntype BatchCallsCallback<T extends Array<unknown>> = (...args: T) => void\n\ntype ScheduleFunction = (callback: () => void) => void\n\n/**\n * Default scheduling function used by the notify manager.\n * Schedules the callback with the system's `setTimeout(callback, 0)`.\n */\nexport const defaultScheduler: ScheduleFunction = systemSetTimeoutZero\n\nexport function createNotifyManager() {\n  let queue: Array<NotifyCallback> = []\n  let transactions = 0\n  let notifyFn: NotifyFunction = (callback) => {\n    callback()\n  }\n  let batchNotifyFn: BatchNotifyFunction = (callback: () => void) => {\n    callback()\n  }\n  let scheduleFn = defaultScheduler\n\n  const schedule = (callback: NotifyCallback): void => {\n    if (transactions) {\n      queue.push(callback)\n    } else {\n      scheduleFn(() => {\n        notifyFn(callback)\n      })\n    }\n  }\n  const flush = (): void => {\n    const originalQueue = queue\n    queue = []\n    if (originalQueue.length) {\n      scheduleFn(() => {\n        batchNotifyFn(() => {\n          originalQueue.forEach((callback) => {\n            notifyFn(callback)\n          })\n        })\n      })\n    }\n  }\n\n  return {\n    /**\n     * Batches all updates scheduled inside the passed callback.\n     * This is mainly used internally to optimize query client updating.\n     * Batches can be nested; the queue is only flushed once the outermost `batch` call finishes.\n     * The return value of `callback` is passed through.\n     */\n    batch: <T>(callback: () => T): T => {\n      let result\n      transactions++\n      try {\n        result = callback()\n      } finally {\n        transactions--\n        if (!transactions) {\n          flush()\n        }\n      }\n      return result\n    },\n    /**\n     * All calls to the wrapped function will be batched.\n     */\n    batchCalls: <T extends Array<unknown>>(\n      callback: BatchCallsCallback<T>,\n    ): BatchCallsCallback<T> => {\n      return (...args) => {\n        schedule(() => {\n          callback(...args)\n        })\n      }\n    },\n    /**\n     * Schedules a function to be run on the next batch.\n     * By default, the batch is run with a `setTimeout`, but this can be configured via `setScheduler`.\n     */\n    schedule,\n    /**\n     * Use this method to set a custom notify function.\n     * This can be used to for example wrap notifications with `React.act` while running tests.\n     */\n    setNotifyFunction: (fn: NotifyFunction) => {\n      notifyFn = fn\n    },\n    /**\n     * Use this method to set a custom function to batch notifications together into a single tick.\n     * Framework adapters use this to plug in their own batching primitive, so that a single query\n     * update only triggers one re-render instead of one per subscriber.\n     *\n     * @example\n     * ```ts\n     * import { notifyManager } from '@tanstack/query-core'\n     * import { batch } from 'solid-js'\n     *\n     * notifyManager.setBatchNotifyFunction(batch)\n     * ```\n     */\n    setBatchNotifyFunction: (fn: BatchNotifyFunction) => {\n      batchNotifyFn = fn\n    },\n    /**\n     * Configures a custom callback that schedules when the next batch runs.\n     * The default behavior is `setTimeout(callback, 0)`.\n     *\n     * @example\n     * ```ts\n     * import { notifyManager } from '@tanstack/query-core'\n     *\n     * // Schedule batches in the next microtask\n     * notifyManager.setScheduler(queueMicrotask)\n     *\n     * // Schedule batches before the next frame is rendered\n     * notifyManager.setScheduler(requestAnimationFrame)\n     *\n     * // Schedule batches some time in the future\n     * notifyManager.setScheduler((cb) => setTimeout(cb, 10))\n     * ```\n     */\n    setScheduler: (fn: ScheduleFunction) => {\n      scheduleFn = fn\n    },\n  } as const\n}\n\n// SINGLETON\n\n/**\n * Handles scheduling and batching callbacks in TanStack Query.\n */\nexport const notifyManager = createNotifyManager()\n"],"mappings":";;;;;;AAkBA,MAAa,mBAAqC;AAElD,SAAgB,sBAAsB;CACpC,IAAI,QAA+B,CAAC;CACpC,IAAI,eAAe;CACnB,IAAI,YAA4B,aAAa;EAC3C,SAAS;CACX;CACA,IAAI,iBAAsC,aAAyB;EACjE,SAAS;CACX;CACA,IAAI,aAAa;CAEjB,MAAM,YAAY,aAAmC;EACnD,IAAI,cACF,MAAM,KAAK,QAAQ;OAEnB,iBAAiB;GACf,SAAS,QAAQ;EACnB,CAAC;CAEL;CACA,MAAM,cAAoB;EACxB,MAAM,gBAAgB;EACtB,QAAQ,CAAC;EACT,IAAI,cAAc,QAChB,iBAAiB;GACf,oBAAoB;IAClB,cAAc,SAAS,aAAa;KAClC,SAAS,QAAQ;IACnB,CAAC;GACH,CAAC;EACH,CAAC;CAEL;CAEA,OAAO;;;;;;;EAOL,QAAW,aAAyB;GAClC,IAAI;GACJ;GACA,IAAI;IACF,SAAS,SAAS;GACpB,UAAU;IACR;IACA,IAAI,CAAC,cACH,MAAM;GAEV;GACA,OAAO;EACT;;;;EAIA,aACE,aAC0B;GAC1B,QAAQ,GAAG,SAAS;IAClB,eAAe;KACb,SAAS,GAAG,IAAI;IAClB,CAAC;GACH;EACF;;;;;EAKA;;;;;EAKA,oBAAoB,OAAuB;GACzC,WAAW;EACb;;;;;;;;;;;;;;EAcA,yBAAyB,OAA4B;GACnD,gBAAgB;EAClB;;;;;;;;;;;;;;;;;;;EAmBA,eAAe,OAAyB;GACtC,aAAa;EACf;CACF;AACF;;;;AAOA,MAAa,gBAAgB,oBAAoB"}

package/build/modern/onlineManager.cjs

@@ -1,6 +1,15 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const require_subscribable = require("./subscribable.cjs");
 //#region src/onlineManager.ts
+/**
+* The `OnlineManager` manages the online state within TanStack Query. It can
+* be used to change the default event listeners or to manually change the
+* online state.
+*
+* By default, the `onlineManager` assumes an active network connection, and
+* listens to the `online` and `offline` events on the `window` object to
+* detect changes.
+*/
 var OnlineManager = class extends require_subscribable.Subscribable {
 	#online = true;
 	#cleanup;
@@ -29,11 +38,43 @@ var OnlineManager = class extends require_subscribable.Subscribable {
 			this.#cleanup = void 0;
 		}
 	}
+	/**
+	* `setEventListener` can be used to set a custom event listener that will
+	* be used to determine the online state. The provided `setup` function
+	* receives a `setOnline` callback that should be called with a `boolean`
+	* whenever the online state changes.
+	*
+	* @example
+	* ```ts
+	* import NetInfo from '@react-native-community/netinfo'
+	* import { onlineManager } from '@tanstack/query-core'
+	*
+	* onlineManager.setEventListener((setOnline) => {
+	*   return NetInfo.addEventListener((state) => {
+	*     setOnline(!!state.isConnected)
+	*   })
+	* })
+	* ```
+	*/
 	setEventListener(setup) {
 		this.#setup = setup;
 		this.#cleanup?.();
 		this.#cleanup = setup(this.setOnline.bind(this));
 	}
+	/**
+	* `setOnline` can be used to manually set the online state.
+	*
+	* @example
+	* ```ts
+	* import { onlineManager } from '@tanstack/query-core'
+	*
+	* // Set to online
+	* onlineManager.setOnline(true)
+	*
+	* // Set to offline
+	* onlineManager.setOnline(false)
+	* ```
+	*/
 	setOnline(online) {
 		if (this.#online !== online) {
 			this.#online = online;
@@ -42,10 +83,16 @@ var OnlineManager = class extends require_subscribable.Subscribable {
 			});
 		}
 	}
+	/**
+	* `isOnline` can be used to get the current online state.
+	*/
 	isOnline() {
 		return this.#online;
 	}
 };
+/**
+* Singleton instance of {@link OnlineManager}, used to manage and observe the online state within TanStack Query.
+*/
 const onlineManager = new OnlineManager();
 //#endregion
 exports.OnlineManager = OnlineManager;

package/build/modern/onlineManager.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"onlineManager.cjs","names":["Subscribable","#setup","#cleanup","#online"],"sources":["../../src/onlineManager.ts"],"sourcesContent":["import { Subscribable } from './subscribable'\n\ntype Listener = (online: boolean) => void\ntype SetupFn = (setOnline: Listener) => (() => void) | undefined\n\nexport class OnlineManager extends Subscribable<Listener> {\n  #online = true\n  #cleanup?: () => void\n\n  #setup: SetupFn\n\n  constructor() {\n    super()\n    this.#setup = (onOnline) => {\n      // addEventListener does not exist in React Native, but window does\n      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n      if (typeof window !== 'undefined' && window.addEventListener) {\n        const onlineListener = () => onOnline(true)\n        const offlineListener = () => onOnline(false)\n        // Listen to online\n        window.addEventListener('online', onlineListener, false)\n        window.addEventListener('offline', offlineListener, false)\n\n        return () => {\n          // Be sure to unsubscribe if a new handler is set\n          window.removeEventListener('online', onlineListener)\n          window.removeEventListener('offline', offlineListener)\n        }\n      }\n\n      return\n    }\n  }\n\n  protected onSubscribe(): void {\n    if (!this.#cleanup) {\n      this.setEventListener(this.#setup)\n    }\n  }\n\n  protected onUnsubscribe() {\n    if (!this.hasListeners()) {\n      this.#cleanup?.()\n      this.#cleanup = undefined\n    }\n  }\n\n  setEventListener(setup: SetupFn): void {\n    this.#setup = setup\n    this.#cleanup?.()\n    this.#cleanup = setup(this.setOnline.bind(this))\n  }\n\n  setOnline(online: boolean): void {\n    const changed = this.#online !== online\n\n    if (changed) {\n      this.#online = online\n      this.listeners.forEach((listener) => {\n        listener(online)\n      })\n    }\n  }\n\n  isOnline(): boolean {\n    return this.#online\n  }\n}\n\nexport const onlineManager = new OnlineManager()\n"],"mappings":";;;AAKA,IAAa,gBAAb,cAAmCA,qBAAAA,aAAuB;CACxD,UAAU;CACV;CAEA;CAEA,cAAc;EACZ,MAAM;EACN,KAAKC,UAAU,aAAa;GAG1B,IAAI,OAAO,WAAW,eAAe,OAAO,kBAAkB;IAC5D,MAAM,uBAAuB,SAAS,IAAI;IAC1C,MAAM,wBAAwB,SAAS,KAAK;IAE5C,OAAO,iBAAiB,UAAU,gBAAgB,KAAK;IACvD,OAAO,iBAAiB,WAAW,iBAAiB,KAAK;IAEzD,aAAa;KAEX,OAAO,oBAAoB,UAAU,cAAc;KACnD,OAAO,oBAAoB,WAAW,eAAe;IACvD;GACF;EAGF;CACF;CAEA,cAA8B;EAC5B,IAAI,CAAC,KAAKC,UACR,KAAK,iBAAiB,KAAKD,MAAM;CAErC;CAEA,gBAA0B;EACxB,IAAI,CAAC,KAAK,aAAa,GAAG;GACxB,KAAKC,WAAW;GAChB,KAAKA,WAAW,KAAA;EAClB;CACF;CAEA,iBAAiB,OAAsB;EACrC,KAAKD,SAAS;EACd,KAAKC,WAAW;EAChB,KAAKA,WAAW,MAAM,KAAK,UAAU,KAAK,IAAI,CAAC;CACjD;CAEA,UAAU,QAAuB;EAG/B,IAFgB,KAAKC,YAAY,QAEpB;GACX,KAAKA,UAAU;GACf,KAAK,UAAU,SAAS,aAAa;IACnC,SAAS,MAAM;GACjB,CAAC;EACH;CACF;CAEA,WAAoB;EAClB,OAAO,KAAKA;CACd;AACF;AAEA,MAAa,gBAAgB,IAAI,cAAc"}
+{"version":3,"file":"onlineManager.cjs","names":["Subscribable","#setup","#cleanup","#online"],"sources":["../../src/onlineManager.ts"],"sourcesContent":["import { Subscribable } from './subscribable'\n\ntype Listener = (online: boolean) => void\ntype SetupFn = (setOnline: Listener) => (() => void) | undefined\n\n/**\n * The `OnlineManager` manages the online state within TanStack Query. It can\n * be used to change the default event listeners or to manually change the\n * online state.\n *\n * By default, the `onlineManager` assumes an active network connection, and\n * listens to the `online` and `offline` events on the `window` object to\n * detect changes.\n */\nexport class OnlineManager extends Subscribable<Listener> {\n  #online = true\n  #cleanup?: () => void\n\n  #setup: SetupFn\n\n  constructor() {\n    super()\n    this.#setup = (onOnline) => {\n      // addEventListener does not exist in React Native, but window does\n      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n      if (typeof window !== 'undefined' && window.addEventListener) {\n        const onlineListener = () => onOnline(true)\n        const offlineListener = () => onOnline(false)\n        // Listen to online\n        window.addEventListener('online', onlineListener, false)\n        window.addEventListener('offline', offlineListener, false)\n\n        return () => {\n          // Be sure to unsubscribe if a new handler is set\n          window.removeEventListener('online', onlineListener)\n          window.removeEventListener('offline', offlineListener)\n        }\n      }\n\n      return\n    }\n  }\n\n  protected onSubscribe(): void {\n    if (!this.#cleanup) {\n      this.setEventListener(this.#setup)\n    }\n  }\n\n  protected onUnsubscribe() {\n    if (!this.hasListeners()) {\n      this.#cleanup?.()\n      this.#cleanup = undefined\n    }\n  }\n\n  /**\n   * `setEventListener` can be used to set a custom event listener that will\n   * be used to determine the online state. The provided `setup` function\n   * receives a `setOnline` callback that should be called with a `boolean`\n   * whenever the online state changes.\n   *\n   * @example\n   * ```ts\n   * import NetInfo from '@react-native-community/netinfo'\n   * import { onlineManager } from '@tanstack/query-core'\n   *\n   * onlineManager.setEventListener((setOnline) => {\n   *   return NetInfo.addEventListener((state) => {\n   *     setOnline(!!state.isConnected)\n   *   })\n   * })\n   * ```\n   */\n  setEventListener(setup: SetupFn): void {\n    this.#setup = setup\n    this.#cleanup?.()\n    this.#cleanup = setup(this.setOnline.bind(this))\n  }\n\n  /**\n   * `setOnline` can be used to manually set the online state.\n   *\n   * @example\n   * ```ts\n   * import { onlineManager } from '@tanstack/query-core'\n   *\n   * // Set to online\n   * onlineManager.setOnline(true)\n   *\n   * // Set to offline\n   * onlineManager.setOnline(false)\n   * ```\n   */\n  setOnline(online: boolean): void {\n    const changed = this.#online !== online\n\n    if (changed) {\n      this.#online = online\n      this.listeners.forEach((listener) => {\n        listener(online)\n      })\n    }\n  }\n\n  /**\n   * `isOnline` can be used to get the current online state.\n   */\n  isOnline(): boolean {\n    return this.#online\n  }\n}\n\n/**\n * Singleton instance of {@link OnlineManager}, used to manage and observe the online state within TanStack Query.\n */\nexport const onlineManager = new OnlineManager()\n"],"mappings":";;;;;;;;;;;;AAcA,IAAa,gBAAb,cAAmCA,qBAAAA,aAAuB;CACxD,UAAU;CACV;CAEA;CAEA,cAAc;EACZ,MAAM;EACN,KAAKC,UAAU,aAAa;GAG1B,IAAI,OAAO,WAAW,eAAe,OAAO,kBAAkB;IAC5D,MAAM,uBAAuB,SAAS,IAAI;IAC1C,MAAM,wBAAwB,SAAS,KAAK;IAE5C,OAAO,iBAAiB,UAAU,gBAAgB,KAAK;IACvD,OAAO,iBAAiB,WAAW,iBAAiB,KAAK;IAEzD,aAAa;KAEX,OAAO,oBAAoB,UAAU,cAAc;KACnD,OAAO,oBAAoB,WAAW,eAAe;IACvD;GACF;EAGF;CACF;CAEA,cAA8B;EAC5B,IAAI,CAAC,KAAKC,UACR,KAAK,iBAAiB,KAAKD,MAAM;CAErC;CAEA,gBAA0B;EACxB,IAAI,CAAC,KAAK,aAAa,GAAG;GACxB,KAAKC,WAAW;GAChB,KAAKA,WAAW,KAAA;EAClB;CACF;;;;;;;;;;;;;;;;;;;CAoBA,iBAAiB,OAAsB;EACrC,KAAKD,SAAS;EACd,KAAKC,WAAW;EAChB,KAAKA,WAAW,MAAM,KAAK,UAAU,KAAK,IAAI,CAAC;CACjD;;;;;;;;;;;;;;;CAgBA,UAAU,QAAuB;EAG/B,IAFgB,KAAKC,YAAY,QAEpB;GACX,KAAKA,UAAU;GACf,KAAK,UAAU,SAAS,aAAa;IACnC,SAAS,MAAM;GACjB,CAAC;EACH;CACF;;;;CAKA,WAAoB;EAClB,OAAO,KAAKA;CACd;AACF;;;;AAKA,MAAa,gBAAgB,IAAI,cAAc"}

package/build/modern/onlineManager.d.cts

@@ -2,15 +2,62 @@ import { t as Subscribable } from "./subscribable-CbifVTKz.cjs";
 //#region src/onlineManager.d.ts
 type Listener = (online: boolean) => void;
 type SetupFn = (setOnline: Listener) => (() => void) | undefined;
+/**
+ * The `OnlineManager` manages the online state within TanStack Query. It can
+ * be used to change the default event listeners or to manually change the
+ * online state.
+ *
+ * By default, the `onlineManager` assumes an active network connection, and
+ * listens to the `online` and `offline` events on the `window` object to
+ * detect changes.
+ */
 declare class OnlineManager extends Subscribable<Listener> {
   #private;
   constructor();
   protected onSubscribe(): void;
   protected onUnsubscribe(): void;
+  /**
+   * `setEventListener` can be used to set a custom event listener that will
+   * be used to determine the online state. The provided `setup` function
+   * receives a `setOnline` callback that should be called with a `boolean`
+   * whenever the online state changes.
+   *
+   * @example
+   * ```ts
+   * import NetInfo from '@react-native-community/netinfo'
+   * import { onlineManager } from '@tanstack/query-core'
+   *
+   * onlineManager.setEventListener((setOnline) => {
+   *   return NetInfo.addEventListener((state) => {
+   *     setOnline(!!state.isConnected)
+   *   })
+   * })
+   * ```
+   */
   setEventListener(setup: SetupFn): void;
+  /**
+   * `setOnline` can be used to manually set the online state.
+   *
+   * @example
+   * ```ts
+   * import { onlineManager } from '@tanstack/query-core'
+   *
+   * // Set to online
+   * onlineManager.setOnline(true)
+   *
+   * // Set to offline
+   * onlineManager.setOnline(false)
+   * ```
+   */
   setOnline(online: boolean): void;
+  /**
+   * `isOnline` can be used to get the current online state.
+   */
   isOnline(): boolean;
 }
+/**
+ * Singleton instance of {@link OnlineManager}, used to manage and observe the online state within TanStack Query.
+ */
 declare const onlineManager: OnlineManager;
 //#endregion
 export { OnlineManager, onlineManager };

package/build/modern/onlineManager.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"onlineManager.d.cts","names":[],"sources":["../../src/onlineManager.ts"],"mappings":";;KAEK,YAAY;KACZ,WAAW,WAAW;cAEd,sBAAsB,aAAa;;;YA6BpC;YAMA;EAOV,iBAAiB,OAAO;EAMxB,UAAU;EAWV;;cAKW,eAAa"}
+{"version":3,"file":"onlineManager.d.cts","names":[],"sources":["../../src/onlineManager.ts"],"mappings":";;KAEK,YAAY;KACZ,WAAW,WAAW;;;;;;;;;;cAWd,sBAAsB,aAAa;;;YA6BpC;YAMA;;;;;;;;;;;;;;;;;;;EAyBV,iBAAiB,OAAO;;;;;;;;;;;;;;;EAoBxB,UAAU;;;;EAcV;;;;;cAQW,eAAa"}

package/build/modern/onlineManager.d.ts

@@ -2,15 +2,62 @@ import { t as Subscribable } from "./subscribable-CbifVTKz.js";
 //#region src/onlineManager.d.ts
 type Listener = (online: boolean) => void;
 type SetupFn = (setOnline: Listener) => (() => void) | undefined;
+/**
+ * The `OnlineManager` manages the online state within TanStack Query. It can
+ * be used to change the default event listeners or to manually change the
+ * online state.
+ *
+ * By default, the `onlineManager` assumes an active network connection, and
+ * listens to the `online` and `offline` events on the `window` object to
+ * detect changes.
+ */
 declare class OnlineManager extends Subscribable<Listener> {
   #private;
   constructor();
   protected onSubscribe(): void;
   protected onUnsubscribe(): void;
+  /**
+   * `setEventListener` can be used to set a custom event listener that will
+   * be used to determine the online state. The provided `setup` function
+   * receives a `setOnline` callback that should be called with a `boolean`
+   * whenever the online state changes.
+   *
+   * @example
+   * ```ts
+   * import NetInfo from '@react-native-community/netinfo'
+   * import { onlineManager } from '@tanstack/query-core'
+   *
+   * onlineManager.setEventListener((setOnline) => {
+   *   return NetInfo.addEventListener((state) => {
+   *     setOnline(!!state.isConnected)
+   *   })
+   * })
+   * ```
+   */
   setEventListener(setup: SetupFn): void;
+  /**
+   * `setOnline` can be used to manually set the online state.
+   *
+   * @example
+   * ```ts
+   * import { onlineManager } from '@tanstack/query-core'
+   *
+   * // Set to online
+   * onlineManager.setOnline(true)
+   *
+   * // Set to offline
+   * onlineManager.setOnline(false)
+   * ```
+   */
   setOnline(online: boolean): void;
+  /**
+   * `isOnline` can be used to get the current online state.
+   */
   isOnline(): boolean;
 }
+/**
+ * Singleton instance of {@link OnlineManager}, used to manage and observe the online state within TanStack Query.
+ */
 declare const onlineManager: OnlineManager;
 //#endregion
 export { OnlineManager, onlineManager };

package/build/modern/onlineManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"onlineManager.d.ts","names":[],"sources":["../../src/onlineManager.ts"],"mappings":";;KAEK,YAAY;KACZ,WAAW,WAAW;cAEd,sBAAsB,aAAa;;;YA6BpC;YAMA;EAOV,iBAAiB,OAAO;EAMxB,UAAU;EAWV;;cAKW,eAAa"}
+{"version":3,"file":"onlineManager.d.ts","names":[],"sources":["../../src/onlineManager.ts"],"mappings":";;KAEK,YAAY;KACZ,WAAW,WAAW;;;;;;;;;;cAWd,sBAAsB,aAAa;;;YA6BpC;YAMA;;;;;;;;;;;;;;;;;;;EAyBV,iBAAiB,OAAO;;;;;;;;;;;;;;;EAoBxB,UAAU;;;;EAcV;;;;;cAQW,eAAa"}