Defined in: packages/query-core/src/onlineManager.ts:15
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.
Extends#
Subscribable<Listener>
Properties#
| Property | Modifier | Type |
|---|---|---|
listeners | protected | Set<Listener> |
Methods#
hasListeners()#
hasListeners(): boolean;
Defined in: packages/query-core/src/subscribable.ts:19
Returns#
boolean
Inherited from#
Subscribable.hasListeners
isOnline()#
isOnline(): boolean;
Defined in: packages/query-core/src/onlineManager.ts:109
isOnline can be used to get the current online state.
Returns#
boolean
onSubscribe()#
protected onSubscribe(): void;
Defined in: packages/query-core/src/onlineManager.ts:44
Returns#
void
Overrides#
Subscribable.onSubscribe
onUnsubscribe()#
protected onUnsubscribe(): void;
Defined in: packages/query-core/src/onlineManager.ts:50
Returns#
void
Overrides#
Subscribable.onUnsubscribe
setEventListener()#
setEventListener(setup: SetupFn): void;
Defined in: packages/query-core/src/onlineManager.ts:75
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.
Parameters#
setup#
SetupFn
Returns#
void
Example#
import NetInfo from '@react-native-community/netinfo'
import { onlineManager } from '@tanstack/query-core'
onlineManager.setEventListener((setOnline) => {
return NetInfo.addEventListener((state) => {
setOnline(!!state.isConnected)
})
})
setOnline()#
setOnline(online: boolean): void;
Defined in: packages/query-core/src/onlineManager.ts:95
setOnline can be used to manually set the online state.
Parameters#
online#
boolean
Returns#
void
Example#
import { onlineManager } from '@tanstack/query-core'
// Set to online
onlineManager.setOnline(true)
// Set to offline
onlineManager.setOnline(false)
subscribe()#
subscribe(listener: Listener): () => void;
Defined in: packages/query-core/src/subscribable.ts:8
Parameters#
listener#
Listener
Returns#
(): void;
Returns#
void
Inherited from#
Subscribable.subscribe