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/provideIsRestoring.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

813 B

id title
provideIsRestoring provideIsRestoring
function provideIsRestoring(isRestoring): Provider;

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

Registers a provider for the restore state read by injectIsRestoring. Wire this up wherever you drive a restore yourself — e.g. a persist-client integration — so injectQuery and friends can defer subscribing to their observer (avoiding a race with the restore) until the restore signal flips back to false.

Parameters

isRestoring

Signal<boolean>

A readonly Signal<boolean> that tracks the restore state.

Returns

Provider

A provider for the isRestoring signal.