snapshot of https://github.com/TanStack/query.git (main, 2026-09-16; blobs > 131072B omitted)
This commit is contained in:
23
docs/framework/svelte/reference/variables/skipToken.md
Normal file
23
docs/framework/svelte/reference/variables/skipToken.md
Normal file
@@ -0,0 +1,23 @@
|
||||
---
|
||||
id: skipToken
|
||||
title: skipToken
|
||||
---
|
||||
|
||||
```ts
|
||||
const skipToken: typeof skipToken;
|
||||
```
|
||||
|
||||
Defined in: [packages/query-core/src/utils.ts:522](https://github.com/TanStack/query/blob/main/packages/query-core/src/utils.ts#L522)
|
||||
|
||||
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
|
||||
|
||||
```ts
|
||||
new QueryObserver(queryClient, {
|
||||
queryKey: ['post', postId],
|
||||
queryFn: postId != null ? () => fetchPost(postId) : skipToken,
|
||||
})
|
||||
```
|
||||
Reference in New Issue
Block a user