0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-18 19:33:22 +00:00
query/docs/framework/vue/reference/variables/environmentManager.md
Wonsuk Choi f38e6271b4
chore(*): update '@tanstack/typedoc-config' to v0.3.5 (#12035)
* chore(scripts/generate-docs): read type alias bodies whose type parameters have defaults

* chore(*): update '@tanstack/typedoc-config' to v0.3.5
2026-10-17 11:14:03 +09:00

1.4 KiB

id title
environmentManager environmentManager
const environmentManager: object;

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

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

true if the runtime is treated as a server.

setIsServer()

setIsServer(isServerValue: IsServerValue): void;

Overrides the server check globally.

Parameters

isServerValue

IsServerValue

A function that returns whether the runtime should be treated as a server.

Returns

void

Example

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

environmentManager.setIsServer(() => false)