* chore(*): update '@tanstack/typedoc-config' to v0.3.4 and load its custom settings plugin by package export * docs(framework/*/reference): regenerate reference docs with '@tanstack/typedoc-config' v0.3.4 * docs(framework/*/reference): regenerate reference docs * docs(framework/*/reference): regenerate reference docs
1.4 KiB
| id | title | redirect_from | |
|---|---|---|---|
| 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)