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 f38e6271b4
chore(*): update '@tanstack/typedoc-config' to v0.3.5 (#12035)
* chore(scripts/generate-docs): read type alias bodies whose type parameters have defaults

* chore(*): update '@tanstack/typedoc-config' to v0.3.5
2026-10-17 11:14:03 +09:00

2.4 KiB

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

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

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.

filters properties

Property Type Description
exact? boolean Match mutation key exactly
mutationKey? readonly unknown[] Include mutations matching this mutation key
predicate? (mutation: Mutation<TData, TError, TVariables, TOnMutateResult>) => boolean Include mutations matching this predicate function
status? "error" | "pending" | "success" | "idle" Filter by mutation status

options?

InjectIsMutatingOptions

Additional configuration

options properties

Property Type Description
injector? Injector The Injector in which to create the isMutating signal. If this is not provided, the current injection context will be used instead (via inject).

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'] })
}