InvalidationTarget

InvalidationTarget<Service, Transform> = QueryKey | QueryKeySource | QueryDescriptor<Service, Transform> | undefined

Defined in: react/src/types.ts:764

One entry of invalidateQueries: which queries a successful mutation invalidates.

• a query key, as generateQueryKey or getQueryKey() builds it;
• a query object or query factory (QueryKeySource);
• a method of the mutation’s own reactor, with or without args (QueryDescriptor);
• undefined, which is skipped, so [maybeQuery] and [maybeQuery?.getQueryKey()] are safe when the query is absent.

TanStack Query matches each key by prefix.

Type Parameters

Service

Service = BaseActor

Transform

Transform extends TransformKey = "candid"

Example

createMutation(backend, {
  functionName: "create_post",
  invalidateQueries: [
    postsQuery, // a query object
    getPost, // a query factory: every post, whatever its args
    { functionName: "get_posts_count" }, // a method of this reactor
  ],
})