* 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
2.1 KiB
| id | title |
|---|---|
| DefaultOptions | DefaultOptions |
Defined in: packages/query-core/src/types.ts:1507
Type Parameters
TError
TError = DefaultError
Properties
dehydrate?
optional dehydrate: DehydrateOptions;
Defined in: packages/query-core/src/types.ts:1518
Default options used when dehydrating the client's caches; see DehydrateOptions.
hydrate?
optional hydrate: object;
Defined in: packages/query-core/src/types.ts:1516
Default options used when hydrating queries; see HydrateOptions.
deserializeData?
optional deserializeData: TransformerFn;
Transforms a query's data after it is read from the dehydrated state, reversing serializeData.
mutations?
optional mutations: MutationOptions<unknown, Error, unknown, unknown>;
Default options merged into every mutation restored from the dehydrated state.
queries?
optional queries: QueryOptions<unknown, Error, unknown, readonly unknown[], never>;
Default options merged into every query restored from the dehydrated state.
mutations?
optional mutations: MutationObserverOptions<unknown, TError, unknown, unknown>;
Defined in: packages/query-core/src/types.ts:1514
Default options applied to every mutation, unless overridden per-mutation.
queries?
optional queries: OmitKeyof<QueryObserverOptions<unknown, TError, unknown, unknown, readonly unknown[], never>, "queryKey" | "suspense", "strictly">;
Defined in: packages/query-core/src/types.ts:1509
Default options applied to every query, unless overridden per-query.