Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

isCancelledError.md

32 lines579 Bytes

1---
2id: isCancelledError
3title: isCancelledError
4---
5​
6<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7​
8```ts
9function isCancelledError(value: any): value is CancelledError;
10```
11​
12Defined in: [packages/query-core/src/retryer.ts:136](https://github.com/TanStack/query/blob/main/packages/query-core/src/retryer.ts#L136)
13​
14Checks whether a value is a `CancelledError`.
15​
16## Parameters
17​
18### value
19​
20`any`
21​
22The value to check.
23​
24## Returns
25​
26`value is CancelledError`
27​
28`true` if `value` is a `CancelledError`.
29​
30## Deprecated
31​
32Use instanceof `CancelledError` instead.