Skip to content

Commit

Permalink
docs: Add note on AbortSignal version availability (#2887)
Browse files Browse the repository at this point in the history
Explained that this new AbortSignal feature was introduced at 3.30.0 and that users need to either upgrade (recommended) or use the old cancel function.
  • Loading branch information
sjc5 committed Nov 6, 2021
1 parent c4fa60e commit f348673
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/src/pages/guides/query-cancellation.md
Expand Up @@ -9,6 +9,8 @@ React Query provides each query function with an [`AbortSignal` instance](https:

The `AbortController` API is available in [most runtime environments](https://developer.mozilla.org/docs/Web/API/AbortController#browser_compatibility), but if the runtime environment does not support it then the query function will receive `undefined` in its place. You may choose to polyfill the `AbortController` API if you wish, there are [several available](https://www.npmjs.com/search?q=abortcontroller%20polyfill).

**NOTE:** This feature was introduced at version `3.30.0`. If you are using an older version, you will need to either upgrade (recommended) or use the [old `cancel` function](#old-cancel-function).

## Using `fetch`

```js
Expand Down

1 comment on commit f348673

@vercel
Copy link

@vercel vercel bot commented on f348673 Nov 6, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.