공식문서 : https://tanstack.com/query/v4/docs/guides/filters

Filters

React Query내의 일부 메서드는 QueryFilters 또는 MutationFilter 객체를 허용한다.

Query Filters

query filter는 쿼리와 일치시킬 특정 조건을 가진 객체이다 :

// Cancel all queries
await queryClient.cancelQueries()

// Remove all inactive queries that begin with `posts` in the key
queryClient.removeQueries(['posts'], { type: 'inactive' })

// Refetch all active queries
await queryClient.refetchQueries({ type: 'active' })

// Refetch all active queries that begin with `posts` in the key
await queryClient.refetchQueries(['posts'], { type: 'active' })

query filter 객체는 다음 속성을 지원한다 :

• exact?:boolean

  • 쿼리 키로 쿼리를 포괄적으로 검색하지 않으려면, 전달한 정확한 쿼리 키가 있는 쿼리만 반환하는 exact:true 옵션을 전달할 수 있다.

• type?:'active'|'inactive'|'all'

  • 기본값은 'all'
  • active로 설정하면 active 쿼리들과 일치
  • inactive로 설정하면 inactive 쿼리들과 일치

• stale?:boolean

  • true로 설정하면 stale 쿼리들과 일치
  • false로 설정하면 fresh 쿼리들과 일치

• fetchStatus?:FetchStatus

  • fetching으로 설정하면 현재 fetch중인 쿼리들과 일치
  • paused로 설정하면 fetch하려고 했지만, 일시중지된 쿼리들과 일치
  • idle로 설정하면 fetch중이 아닌 쿼리들과 일치

• predicate?: (query: Query) => boolean

  • 이 predicate 함수는 캐시에 있는 모든 단일 쿼리에 대해 호출되며 found 쿼리에 대해 참을 반환할 것으로 예상된다.

• queryKey?:QueryKey

  • 일치시킬 쿼리 키를 정의하려면 이 속성을 설정해라

Mutation Filters

mutation filter는 mutation과 일치시킬 특정 조건이 있는 객체이다 :

// Get the number of all fetching mutations
await queryClient.isMutating()

// Filter mutations by mutationKey
await queryClient.isMutating({ mutationKey: ["post"] })

// Filter mutations using a predicate function
await queryClient.isMutating({ predicate: (mutation) => mutation.options.variables?.id === 1 })

mutation filter 객체는 다음 속성을 지원한다 :

• exact?:boolean

  • mutation key를 사용하여 mutation을 포괄적으로 검색하지 않으려면 전달한 정확한 mutation key를 가지는 mutation만 반환하는 exact:true 옵션을 전달할 수 있다.

• fetching?:boolean

  • true로 설정하면 현재 fetch중인 mutation과 일치

  • false로 설정하면 현재 fetch중이 아닌 mutation과 일치

• predicate?: (mutation: Mutation) => boolean

  • predicate 함수는 모든 단일 mutation에 대해 호출되며 found mutation에 대해 참을 반환할것으로 예상된다.

• mutationKey?:MutationKey

  • 일치시킬 mutation key를 정의하려면 이 속성을 설정해라.