过滤器 Filters

TanStack Query 中的某些方法可以接受 QueryFilters 或者 MutationFilters 对象。

查询过滤器

一个查询的过滤器是具有特定条件的对象，可将查询与以下各项进行匹配：

// 取消所有查询
await queryClient.cancelQueries();

// 删除所有以`posts`开头的键值的非活跃的查询
queryClient.removeQueries({ queryKey: ["posts"], type: "inactive" });

// 重新获取所有活跃的查询
await queryClient.refetchQueries({ type: 'active' })

// 重新获取键中以`posts`开头的所有活跃的查询
await queryClient.refetchQueries({ queryKey: ['posts'], type: 'active' })

查询过滤器对象支持以下属性：

• queryKey?: QueryKey
  • 设置此属性以定义要匹配的查询键值
• exact?: boolean
  • 如果你不想对键值做模糊查询(search queries inclusively)，则可以传递 exact: true 选项，只返回完整匹配的查询键值
• type?: 'active' | 'inactive' | 'all'
  • 默认为 all
  • 设置为 active 时，它将匹配当前活跃的查询
  • 设置为 inactive 时，它将匹配当前非活跃的查询
• stale?: boolean
  • 设置为 true 时，它将匹配当前过时（staled）的
  • 设置为 false 时，它将匹配当前没过时（fresh）的
• fetchStatus?: FetchStatus
  • 设置为 fetching 时，它将匹配当前正在获取的
  • 设置为 paused 时，它将匹配当前想要获取但被暂停了的
  • 设置为 idle 时，它将匹配当前未在获取的
• predicate?: (query: Query) => boolean
  • 此函数用于需要匹配的每个查询(matching query, 满足其他条件的查询)。如果没有指定其他的过滤规则，这个函数才会针对所有缓存中的查询调用

修改过滤器

修改的过滤器是具有特定条件的对象，可将修改与以下条件进行匹配：

// 获取所有正在获取的修改的数量
await queryClient.isMutating();

// 通过 mutationKey 过滤
await queryClient.isMutating({ mutationKey: ["post"] })

// 使用函数过滤
await queryClient.isMutating({
  predicate: (mutation) => mutation.options.variables?.id === 1,
});

修改过滤器对象支持以下属性：

• mutationKey?: MutationKey
  • 设置此属性以定义要匹配的修改键值
• exact?: boolean
  • 如果你不想对键值做模糊查询，你可以设置 exact: true 选项来返回且只返回完整匹配的
• fetching?: boolean
  • 设置为 true 时，它将匹配当前正在获取的
  • 设置为 false 时，它将匹配当前未在获取的
• predicate?: (mutation: Mutation) => boolean
  • 此函数用于需要匹配的每个查询(matching query, 满足其他条件的查询)。如果没有指定其他的过滤规则，这个函数才会针对所有缓存中的查询调用