TanStack
API Reference

CancelOptions

Defined in: packages/query-core/src/types.ts:2389

Options for cancelling an in-flight fetch, e.g. via query.cancel(). They are carried on the CancelledError that the cancelled fetch rejects with.

Properties

PropertyTypeDescription
revert?booleanIf true, the query goes back to the state it had before the fetch started, instead of getting the cancellation error.
silent?booleanIf true, the cancellation error isn't surfaced, e.g. because another fetch replaces the cancelled one.