0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
query/docs/framework/solid/reference/interfaces/OnlineManager.md
Wonsuk Choi e57f8163b1
docs(query-core): add JSDoc across the package and expose it in generated reference docs (#11438)
* docs(query-core): add JSDoc across the package and expose it in generated reference docs

* docs(config.json): add sidebar entries for newly generated query-core reference docs

* docs(query-core): migrate remaining prose from the legacy 'docs/reference' pages into JSDoc

* docs(query-core): remove legacy 'docs/reference' pages superseded by the generated reference

* docs(query-core): regenerate reference docs after merging main

* docs(query-core): document missing default values for MutationOptions, combine, and QueryFilters.type

* fix(query-devtools): drop unnecessary 'query-core' project reference

* docs(query-core): document missing default values and normalize 'Defaults to' spacing

* docs(query-core): fix 'environmentManager' JSDoc example
2026-09-07 18:22:38 +02:00

3.6 KiB

id title
OnlineManager OnlineManager

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

listeners

protected listeners: Set<Listener>;

Defined in: packages/query-core/src/subscribable.ts:2

Inherited from

Subscribable.listeners

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): 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): 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): () => void;

Defined in: packages/query-core/src/subscribable.ts:8

Parameters

listener

Listener

Returns

(): void;
Returns

void

Inherited from

Subscribable.subscribe