Skip to content

CancelledError.md

Latest commit

 

History

History
77 lines (50 loc) · 1.65 KB

CancelledError.md

File metadata and controls

77 lines (50 loc) · 1.65 KB
Raw
id CancelledError
title 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