0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
query/docs/framework/lit/reference/classes/CancelledError.md
Wonsuk Choi 1d2cf91305
chore(*): update '@tanstack/typedoc-config' to v0.3.4 (#11817)
* chore(*): update '@tanstack/typedoc-config' to v0.3.4 and load its custom settings plugin by package export

* docs(framework/*/reference): regenerate reference docs with '@tanstack/typedoc-config' v0.3.4

* docs(framework/*/reference): regenerate reference docs

* docs(framework/*/reference): regenerate reference docs
2026-10-05 12:41:28 +09:00

1.6 KiB

id title
CancelledError CancelledError

Defined in: packages/query-core/src/retryer.ts:120

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?: CancelOptions): CancelledError;

Defined in: packages/query-core/src/retryer.ts:123

Parameters

options?

CancelOptions

Returns

CancelledError

Overrides

Error.constructor

Properties

revert?

optional revert?: boolean;

Defined in: packages/query-core/src/retryer.ts:121


silent?

optional silent?: boolean;

Defined in: packages/query-core/src/retryer.ts:122