upstream-tanstack-query/docs/framework/lit/reference/classes/CancelledError.md

id, title

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?

CancelOptions

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