0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
query/docs/framework/angular/reference/variables/environmentManager.md
Wonsuk Choi 4bb041f4d9
docs(query-core): add missing JSDoc to mutation, retryer, managers, and infinite query behavior (#11838)
* docs(query-core): add missing JSDoc to mutation, retryer, managers, and infinite query behavior

* docs(query-core/mutation): note that 'continue' rejects when the resumed mutation fails

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

1.3 KiB

id title
environmentManager environmentManager
const environmentManager: object;

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

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)