Skip to content

skipToken.md

Latest commit

 

History

History
25 lines (19 loc) · 726 Bytes

skipToken.md

File metadata and controls

25 lines (19 loc) · 726 Bytes
Raw
id skipToken
title skipToken 
const skipToken: typeof skipToken;

Defined in: packages/query-core/src/utils.ts:628

Sentinel value that can be passed as a query's queryFn to conditionally disable the query (equivalent to enabled: false) while preserving full type inference for the query's data. Unlike enabled: false, a query disabled via skipToken cannot be triggered with refetch.

Example

new QueryObserver(queryClient, {
  queryKey: ['post', postId],
  queryFn: postId != null ? () => fetchPost(postId) : skipToken,
})