0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
query/docs/framework/react/reference/variables/environmentManager.md
Wonsuk Choi 6e16d3946a
docs(query-core/utils): add missing JSDoc to utility functions (#11830)
* docs(query-core/utils): add missing JSDoc to utility functions

* docs(query-core/utils): clarify that 'addToEnd' and 'addToStart' drop at most one item

* docs(framework/*/reference): regenerate reference docs
2026-10-04 02:47:14 +09:00

1.3 KiB

id title redirect_from
environmentManager environmentManager
reference/environmentManager
const environmentManager: object;

Defined in: packages/query-core/src/environmentManager.ts:28

Manages how TanStack Query detects whether the current runtime should be treated as server-side, which disables scheduling refetch timers and changes the default retry count and gcTime. By default, the detection treats a missing window (or the presence of a Deno global) as server.

Override this for runtimes where that default detection would give the wrong answer — for example, a Service Worker, where window is undefined even though the environment should behave like a client.

Type Declaration

isServer()

isServer: () => boolean;

Returns whether the current runtime should be treated as a server environment.

Returns

boolean

setIsServer()

setIsServer(isServerValue: IsServerValue): void;

Overrides the server check globally.

Parameters

isServerValue

IsServerValue

Returns

void

Example

import { environmentManager } from '@tanstack/query-core'

environmentManager.setIsServer(() => false)