mirror of
https://github.com/TanStack/query.git
synced 2026-11-16 22:50:20 +00:00
* docs(*): add parameter and result property tables to reference function pages and an overview to overloaded ones * docs(*): link to the base type's properties when a parameter or result type has no property table * docs(framework/*/reference): regenerate reference docs * docs(framework/*/reference): regenerate reference docs * chore(scripts/generate-docs): restore the 'dirname' import that the merge dropped * docs(framework/*/reference): regenerate reference docs * docs(scripts/generate-docs): label overloads in the overview with their declared parameter and return types * docs(framework/*/reference): regenerate reference docs * docs(scripts/generate-docs): convert declared intersection types from the source so signatures keep their alias names * docs(framework/*/reference): regenerate reference docs * docs(scripts/generate-docs): reword a comment to avoid the unknown word 'inlines' * docs(scripts/generate-docs): skip a parameter table on overloaded pages when its heading is missing
2.3 KiB
2.3 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?
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'] })
}