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
1.1 KiB
1.1 KiB
| id | title |
|---|---|
| dehydrateQuery | dehydrateQuery |
function dehydrateQuery(
query,
serializeData?,
shouldRedactErrors?): DehydratedQuery;
Defined in: packages/query-core/src/hydration.ts:148
Dehydrates a single Query into a serializable DehydratedQuery snapshot. Note that most query config (e.g.
queryFn, staleTime) is not dehydrated but instead meant to be configured again when consuming the
de/rehydrated data, typically with useQuery on the client. If the query is still pending, its in-flight
promise is dehydrated too so it can be resumed on the other side instead of re-fetched.
Parameters
query
The query to dehydrate.
serializeData?
TransformerFn
Optional transform applied to query.state.data before it is included in the snapshot.
shouldRedactErrors?
(error) => boolean
Optional predicate; if it returns false for the promise's rejection error, that
error is kept as-is instead of being redacted.
Returns
DehydratedQuery