mirror of
https://github.com/TanStack/query.git
synced 2026-11-16 22:50:20 +00:00
* 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
1.2 KiB
1.2 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
setIsServer()
setIsServer(isServerValue): void;
Overrides the server check globally.
Parameters
isServerValue
IsServerValue
Returns
void
Example
import { environmentManager } from '@tanstack/query-core'
environmentManager.setIsServer(() => false)