框架
版本

OnlineManager

OnlineManager 管理 TanStack Query 中的在线状态。它可用于更改默认事件监听器或手动更改在线状态。

默认情况下,onlineManager 假定网络连接处于活动状态,并监听 window 对象上的 onlineoffline 事件以检测更改。

在以前的版本中,navigator.onLine 用于确定网络状态。但是,它在基于 Chromium 的浏览器中效果不佳。关于误报有很多问题,这导致查询被错误地标记为 offline

为了规避这个问题,我们现在始终以 online: true 开始,并且仅监听 onlineoffline 事件来更新状态。

这应该会减少误报的可能性,但是,对于通过 serviceWorkers 加载的离线应用程序来说,这可能意味着误报,即使没有互联网连接,这些应用程序也可以工作。

其可用方法是

onlineManager.setEventListener

setEventListener 可用于设置自定义事件监听器

tsx
import NetInfo from '@react-native-community/netinfo'
import { onlineManager } from '@tanstack/react-query'

onlineManager.setEventListener((setOnline) => {
  return NetInfo.addEventListener((state) => {
    setOnline(!!state.isConnected)
  })
})
import NetInfo from '@react-native-community/netinfo'
import { onlineManager } from '@tanstack/react-query'

onlineManager.setEventListener((setOnline) => {
  return NetInfo.addEventListener((state) => {
    setOnline(!!state.isConnected)
  })
})

onlineManager.subscribe

subscribe 可用于订阅在线状态的更改。它返回一个取消订阅函数

tsx
import { onlineManager } from '@tanstack/react-query'

const unsubscribe = onlineManager.subscribe((isOnline) => {
  console.log('isOnline', isOnline)
})
import { onlineManager } from '@tanstack/react-query'

const unsubscribe = onlineManager.subscribe((isOnline) => {
  console.log('isOnline', isOnline)
})

onlineManager.setOnline

setOnline 可用于手动设置在线状态。

tsx
import { onlineManager } from '@tanstack/react-query'

// Set to online
onlineManager.setOnline(true)

// Set to offline
onlineManager.setOnline(false)
import { onlineManager } from '@tanstack/react-query'

// Set to online
onlineManager.setOnline(true)

// Set to offline
onlineManager.setOnline(false)

选项

  • online: boolean

onlineManager.isOnline

isOnline 可用于获取当前的在线状态。

tsx
const isOnline = onlineManager.isOnline()
const isOnline = onlineManager.isOnline()