0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
query/docs/framework/angular/reference/interfaces/CancelOptions.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

783 B

id title
CancelOptions 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

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