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/functions/injectIsRestoring.md
Wonsuk Choi e57f8163b1
docs(query-core): add JSDoc across the package and expose it in generated reference docs (#11438)
* 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
2026-09-07 18:22:38 +02:00

854 B

id title
injectIsRestoring injectIsRestoring
function injectIsRestoring(options?): Signal<boolean>;

Defined in: packages/angular-query-experimental/src/inject-is-restoring.ts:35

Injects a signal that tracks whether a restore (e.g. from a persisted client, wired up via provideIsRestoring) is currently in progress. injectQuery and friends also check this internally to avoid race conditions between the restore and initializing queries.

Parameters

options?

InjectIsRestoringOptions

Additional configuration

Returns

Signal<boolean>

A readonly Signal<boolean> — true while a restore is in progress, false otherwise (the default when no provideIsRestoring provider is registered).