Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

injectIsMutating.md

69 lines2.3 KB

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

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

options?

InjectIsMutatingOptions

Additional configuration

options properties

PropertyTypeDescription
injector?InjectorThe 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'] })
}