UNPKG

@tanstack/query-core

Version:

The framework agnostic core that powers TanStack Query

107 lines (106 loc) • 3.9 kB
import { i as _classPrivateFieldInitSpec, n as _classPrivateFieldGet2, t as _classPrivateFieldSet2 } from "./classPrivateFieldSet2-CukOTU3U.js"; import { Subscribable } from "./subscribable.js"; //#region src/onlineManager.ts var _online = /* @__PURE__ */ new WeakMap(); var _cleanup = /* @__PURE__ */ new WeakMap(); var _setup = /* @__PURE__ */ new WeakMap(); /** * 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 Subscribable { constructor() { super(); _classPrivateFieldInitSpec(this, _online, true); _classPrivateFieldInitSpec(this, _cleanup, void 0); _classPrivateFieldInitSpec(this, _setup, void 0); _classPrivateFieldSet2(_setup, this, (onOnline) => { if (typeof window !== "undefined" && window.addEventListener) { const onlineListener = () => onOnline(true); const offlineListener = () => onOnline(false); window.addEventListener("online", onlineListener, false); window.addEventListener("offline", offlineListener, false); return () => { window.removeEventListener("online", onlineListener); window.removeEventListener("offline", offlineListener); }; } }); } onSubscribe() { if (!_classPrivateFieldGet2(_cleanup, this)) this.setEventListener(_classPrivateFieldGet2(_setup, this)); } onUnsubscribe() { if (!this.hasListeners()) { var _classPrivateFieldGet2$1; (_classPrivateFieldGet2$1 = _classPrivateFieldGet2(_cleanup, this)) === null || _classPrivateFieldGet2$1 === void 0 || _classPrivateFieldGet2$1.call(this); _classPrivateFieldSet2(_cleanup, this, 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. * @param setup - Receives the `setOnline` callback, registers the event listener, and may return * a cleanup function that is called when the listener is replaced or no longer needed. * @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) { var _classPrivateFieldGet3; _classPrivateFieldSet2(_setup, this, setup); (_classPrivateFieldGet3 = _classPrivateFieldGet2(_cleanup, this)) === null || _classPrivateFieldGet3 === void 0 || _classPrivateFieldGet3.call(this); _classPrivateFieldSet2(_cleanup, this, setup(this.setOnline.bind(this))); } /** * `setOnline` can be used to manually set the online state. * @param online - 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 (_classPrivateFieldGet2(_online, this) !== online) { _classPrivateFieldSet2(_online, this, online); this.listeners.forEach((listener) => { listener(online); }); } } /** * `isOnline` can be used to get the current online state. * @returns `true` if online. */ isOnline() { return _classPrivateFieldGet2(_online, this); } }; /** * Singleton instance of {@link OnlineManager}, used to manage and observe the online state within TanStack Query. */ const onlineManager = new OnlineManager(); //#endregion export { OnlineManager, onlineManager }; //# sourceMappingURL=onlineManager.js.map