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

1.2 KiB

id title
injectIsMutating injectIsMutating
function injectIsMutating(filters?, options?): Signal<number>;

Defined in: packages/angular-query-experimental/src/inject-is-mutating.ts:46

Injects a signal that tracks the number of mutations that your application currently has pending (useful for app-wide loading indicators).

Parameters

filters?

MutationFilters<unknown, Error, unknown, unknown>

The MutationFilters to narrow down the matched mutations.

options?

InjectIsMutatingOptions

Additional configuration

Returns

Signal<number>

A Signal with the number of mutations that your application currently has pending.

Example

@Component({
  selector: 'posts-mutating-indicator',
  template: `
    @if (isMutatingPosts()) {
      <span>Saving posts...</span>
    }
  `,
})
export class PostsMutatingIndicator {
  // How many mutations matching the posts prefix are in progress?
  readonly isMutatingPosts = injectIsMutating({ mutationKey: ['posts'] })
}