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.6 KiB
1.6 KiB
| id | title |
|---|---|
| CancelledError | CancelledError |
Defined in: packages/query-core/src/retryer.ts:77
The error thrown by a Retryer (and surfaced to query.promise/mutation) when a fetch is cancelled, e.g. via
query.cancel(). revert, if true, tells the caller to restore the state the query was in before the fetch
started instead of surfacing the error. silent, if true, tells the caller to suppress this error and instead
resolve with the promise of the fetch that triggered the cancellation.
Example
query.cancel()
try {
await query.promise
} catch (error) {
if (error instanceof CancelledError) {
// the fetch was cancelled, e.g. via `query.cancel()`
}
}
Extends
Error
Constructors
Constructor
new CancelledError(options?): CancelledError;
Defined in: packages/query-core/src/retryer.ts:80
Parameters
options?
Returns
CancelledError
Overrides
Error.constructor
Properties
revert?
optional revert: boolean;
Defined in: packages/query-core/src/retryer.ts:78
silent?
optional silent: boolean;
Defined in: packages/query-core/src/retryer.ts:79