Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

onlineManager.md

58 lines1.3 KB

1---
2id: OnlineManager
3title: OnlineManager
4---
5​
6The `OnlineManager` manages the online state within TanStack Query.
7​
8It can be used to change the default event listeners or to manually change the online state.
9​
10Its available methods are:
11​
12- [`setEventListener`](#onlinemanagerseteventlistener)
13- [`setOnline`](#onlinemanagersetonline)
14- [`isOnline`](#onlinemanagerisonline)
15​
16## `onlineManager.setEventListener`
17​
18`setEventListener` can be used to set a custom event listener:
19​
20```tsx
21import NetInfo from '@react-native-community/netinfo'
22import { onlineManager } from '@tanstack/react-query'
23​
24onlineManager.setEventListener(setOnline => {
25 return NetInfo.addEventListener(state => {
26 setOnline(!!state.isConnected)
27 })
28})
29```
30​
31## `onlineManager.setOnline`
32​
33`setOnline` can be used to manually set the online state. Set `undefined` to fallback to the default online check.
34​
35```tsx
36import { onlineManager } from '@tanstack/react-query'
37​
38// Set to online
39onlineManager.setOnline(true)
40​
41// Set to offline
42onlineManager.setOnline(false)
43​
44// Fallback to the default online check
45onlineManager.setOnline(undefined)
46```
47​
48**Options**
49​
50- `online: boolean | undefined`
51​
52## `onlineManager.isOnline`
53​
54`isOnline` can be used to get the current online state.
55​
56```tsx
57const isOnline = onlineManager.isOnline()
58```