0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-18 19:33:22 +00:00
query/docs/framework/react/reference/interfaces/CancelOptions.md
Wonsuk Choi 9dd4d7d506
docs(query-core/types): add JSDoc to the properties of the exported interfaces and type aliases (#11891)
* docs(query-core/types): add JSDoc to the properties of the exported interfaces and type aliases

* docs(query-core/types): mention mutations in the 'hydrate' default options description
2026-10-05 01:55:45 +09:00

765 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.