mirror of
https://github.com/TanStack/query.git
synced 2026-11-16 22:50:20 +00:00
* docs(query-core): add JSDoc across the package and expose it in generated reference docs * docs(config.json): add sidebar entries for newly generated query-core reference docs * docs(query-core): migrate remaining prose from the legacy 'docs/reference' pages into JSDoc * docs(query-core): remove legacy 'docs/reference' pages superseded by the generated reference * docs(query-core): regenerate reference docs after merging main * docs(query-core): document missing default values for MutationOptions, combine, and QueryFilters.type * fix(query-devtools): drop unnecessary 'query-core' project reference * docs(query-core): document missing default values and normalize 'Defaults to' spacing * docs(query-core): fix 'environmentManager' JSDoc example
653 B
653 B
| id | title |
|---|---|
| skipToken | skipToken |
const skipToken: typeof skipToken;
Defined in: packages/query-core/src/utils.ts:522
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,
})