fix: add isCancel type assert - #4293
#4293Merged
Merged
fix: add isCancel type assert#4293
Conversation
Member
|
Closing as bool is the correct type in this case |
Contributor
Author
|
By isCancel type assert, when the function result is true, the next context typescript will treat the value is Cancel type. It will help developer to write code with code lint @jasonsaayman |
jasonsaayman
added a commit
that referenced
this pull request
May 28, 2022
* Fixing proxy beforeRedirect regression (#4708) * Adding Canceler parameters config and request (#4711) Co-authored-by: Jay <jasonsaayman@gmail.com> * Fixed `toFormData` regression bug (unreleased) with Array-like objects serialization; (#4714) Added `toURLEncodedForm` helper; Added automatic payload serialization to `application/x-www-form-urlencoded` to have parity with `multipart/form-data`; Added test of handling `application/x-www-form-urlencoded` body by express.js; Updated README.md; Added missed param in JSDoc; Fixed hrefs in README.md; Co-authored-by: Jay <jasonsaayman@gmail.com> * Allow webpack users to overwrite buildins (#4715) Co-authored-by: Jay <jasonsaayman@gmail.com> * Fixed `AxiosError` status code type; (#4717) Co-authored-by: Jay <jasonsaayman@gmail.com> * Fixed `AxiosError` stack capturing; (#4718) Co-authored-by: Jay <jasonsaayman@gmail.com> * allow type definition for axios instance methods (#4224) Co-authored-by: Jay <jasonsaayman@gmail.com> * add `string[]` to `AxiosRequestHeaders` type (#4322) Co-authored-by: Jay <jasonsaayman@gmail.com> * Fixing AxiosRequestHeaders typings (#4334) Co-authored-by: Shakirov Kirill <ksshakirov@sberautotech.ru> Co-authored-by: Jay <jasonsaayman@gmail.com> * Added the ability for the `url-encoded-form` serializer to respect the `formSerializer` config; (#4721) Added test for `formSerializer` config in context of `url-encoded-form` serializer; * Updated eslint config; (#4722) Co-authored-by: Jay <jasonsaayman@gmail.com> * fix: add isCancel type assert (#4293) Co-authored-by: Jay <jasonsaayman@gmail.com> * Added data URL support for node.js; (#4725) * Added data URL support for node.js; Added missed data URL protocol for the browser environment; Optimized JSON parsing in the default response transformer; Refactored project structure; Added `cause` prop for AxiosError instance that refers to the original error if it was wrapped with `AxiosError.from` method; Added fromDataURI helper; Added test for handling data:url as an `arraybuffer|text|stream`; * Added throwing of 405 HTTP error if the method is not GET; * Fix/4263/maxbodylength defaults (#4731) * test(http): add test case for default body length in follow-redirects * fix(http): provide proper default body length to follow-redirects Co-authored-by: Jay <jasonsaayman@gmail.com> * Adding types for progress event callbacks (#4675) Co-authored-by: Jay <jasonsaayman@gmail.com> * Fixed bug #4727 : toFormData Blob issue on node>v17; (#4728) * Fixed bug #4727; Added node 18.x to the CI; Added hotfix for `ERR_OSSL_EVP_UNSUPPORTED` issue with karma running on node >=17.x; Added `cross-env` to allow running build and test scripts on Windows platforms; * Added conditional setting of `--openssl-legacy-provider` option for node versions >=17.x; * Refactored ssl-hotfix & test script; * Fixed and refactored default max body length test due to ECONNRESET failure; * Added test for converting the data uri to a Blob; Fixed bug with parsing mime type for Blob; Co-authored-by: Jay <jasonsaayman@gmail.com> * URL params serializer; (#4734) * Refactored BuildURL helper to use URLSearchParams serializer; * Updated typings; Added TS test; * Added `axios.formToJSON` method; (#4735) * Draft * Added `formDataToJSON` helper; Added `axios.formToJSON` method; Added client tests; Co-authored-by: Jay <jasonsaayman@gmail.com> * Bump grunt from 1.5.2 to 1.5.3 (#4743) Bumps [grunt](https://github.com/gruntjs/grunt) from 1.5.2 to 1.5.3. - [Release notes](https://github.com/gruntjs/grunt/releases) - [Changelog](https://github.com/gruntjs/grunt/blob/main/CHANGELOG) - [Commits](gruntjs/grunt@v1.5.2...v1.5.3) --- updated-dependencies: - dependency-name: grunt dependency-type: direct:development ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Updated README.md; (#4742) Updated index.d.ts; Co-authored-by: Jay <jasonsaayman@gmail.com> * chore: removed Travis CI config file as we have moved to GitHub actions * chore: updated actions to run on new version based branches * Fix/4737/timeout error message for http (#4738) * Fixing timeoutErrorMessage in http calls When timeoutErrorMessage was set this did not change anything in the error message, with this change the error message will be the configured message * Testing timeoutErrorMessage in http calls When timeoutErrorMessage was set this did not change anything in the error message, with this change the error message will be the configured message Co-authored-by: Jay <jasonsaayman@gmail.com> * Fixing content-type header repeated (#4745) Co-authored-by: Jay <jasonsaayman@gmail.com> Co-authored-by: Maxime Bargiel <maxime.bargiel@gmail.com> Co-authored-by: 毛呆 <aweikalee@163.com> Co-authored-by: Dmitriy Mozgovoy <robotshara@gmail.com> Co-authored-by: Tom Ceuppens <t-c@live.be> Co-authored-by: Jelle Schutter <jelle@schutter.xyz> Co-authored-by: Rraji Abdelbari <57002508+estarossa0@users.noreply.github.com> Co-authored-by: Kirill Shakirov <kirill-shakirov@mail.ru> Co-authored-by: Shakirov Kirill <ksshakirov@sberautotech.ru> Co-authored-by: chenjigeng <178854407@qq.com> Co-authored-by: Dimitris Halatsis <dimitris_ha@hotmail.com> Co-authored-by: Johann Cooper <johanngcooper@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Victor Augusto <vdbernardes@gmail.com> Co-authored-by: João Gabriel Quaresma <j.quaresmasantos_98@hotmail.com>
jasonsaayman
added a commit
that referenced
this pull request
May 28, 2022
* Fixing proxy beforeRedirect regression (#4708) * Adding Canceler parameters config and request (#4711) Co-authored-by: Jay <jasonsaayman@gmail.com> * Fixed `toFormData` regression bug (unreleased) with Array-like objects serialization; (#4714) Added `toURLEncodedForm` helper; Added automatic payload serialization to `application/x-www-form-urlencoded` to have parity with `multipart/form-data`; Added test of handling `application/x-www-form-urlencoded` body by express.js; Updated README.md; Added missed param in JSDoc; Fixed hrefs in README.md; Co-authored-by: Jay <jasonsaayman@gmail.com> * Allow webpack users to overwrite buildins (#4715) Co-authored-by: Jay <jasonsaayman@gmail.com> * Fixed `AxiosError` status code type; (#4717) Co-authored-by: Jay <jasonsaayman@gmail.com> * Fixed `AxiosError` stack capturing; (#4718) Co-authored-by: Jay <jasonsaayman@gmail.com> * allow type definition for axios instance methods (#4224) Co-authored-by: Jay <jasonsaayman@gmail.com> * add `string[]` to `AxiosRequestHeaders` type (#4322) Co-authored-by: Jay <jasonsaayman@gmail.com> * Fixing AxiosRequestHeaders typings (#4334) Co-authored-by: Shakirov Kirill <ksshakirov@sberautotech.ru> Co-authored-by: Jay <jasonsaayman@gmail.com> * Added the ability for the `url-encoded-form` serializer to respect the `formSerializer` config; (#4721) Added test for `formSerializer` config in context of `url-encoded-form` serializer; * Updated eslint config; (#4722) Co-authored-by: Jay <jasonsaayman@gmail.com> * fix: add isCancel type assert (#4293) Co-authored-by: Jay <jasonsaayman@gmail.com> * Added data URL support for node.js; (#4725) * Added data URL support for node.js; Added missed data URL protocol for the browser environment; Optimized JSON parsing in the default response transformer; Refactored project structure; Added `cause` prop for AxiosError instance that refers to the original error if it was wrapped with `AxiosError.from` method; Added fromDataURI helper; Added test for handling data:url as an `arraybuffer|text|stream`; * Added throwing of 405 HTTP error if the method is not GET; * Fix/4263/maxbodylength defaults (#4731) * test(http): add test case for default body length in follow-redirects * fix(http): provide proper default body length to follow-redirects Co-authored-by: Jay <jasonsaayman@gmail.com> * Adding types for progress event callbacks (#4675) Co-authored-by: Jay <jasonsaayman@gmail.com> * Fixed bug #4727 : toFormData Blob issue on node>v17; (#4728) * Fixed bug #4727; Added node 18.x to the CI; Added hotfix for `ERR_OSSL_EVP_UNSUPPORTED` issue with karma running on node >=17.x; Added `cross-env` to allow running build and test scripts on Windows platforms; * Added conditional setting of `--openssl-legacy-provider` option for node versions >=17.x; * Refactored ssl-hotfix & test script; * Fixed and refactored default max body length test due to ECONNRESET failure; * Added test for converting the data uri to a Blob; Fixed bug with parsing mime type for Blob; Co-authored-by: Jay <jasonsaayman@gmail.com> * URL params serializer; (#4734) * Refactored BuildURL helper to use URLSearchParams serializer; * Updated typings; Added TS test; * Added `axios.formToJSON` method; (#4735) * Draft * Added `formDataToJSON` helper; Added `axios.formToJSON` method; Added client tests; Co-authored-by: Jay <jasonsaayman@gmail.com> * Bump grunt from 1.5.2 to 1.5.3 (#4743) Bumps [grunt](https://github.com/gruntjs/grunt) from 1.5.2 to 1.5.3. - [Release notes](https://github.com/gruntjs/grunt/releases) - [Changelog](https://github.com/gruntjs/grunt/blob/main/CHANGELOG) - [Commits](gruntjs/grunt@v1.5.2...v1.5.3) --- updated-dependencies: - dependency-name: grunt dependency-type: direct:development ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Updated README.md; (#4742) Updated index.d.ts; Co-authored-by: Jay <jasonsaayman@gmail.com> * chore: removed Travis CI config file as we have moved to GitHub actions * chore: updated actions to run on new version based branches * Fix/4737/timeout error message for http (#4738) * Fixing timeoutErrorMessage in http calls When timeoutErrorMessage was set this did not change anything in the error message, with this change the error message will be the configured message * Testing timeoutErrorMessage in http calls When timeoutErrorMessage was set this did not change anything in the error message, with this change the error message will be the configured message Co-authored-by: Jay <jasonsaayman@gmail.com> * Fixing content-type header repeated (#4745) Co-authored-by: Jay <jasonsaayman@gmail.com> Co-authored-by: Maxime Bargiel <maxime.bargiel@gmail.com> Co-authored-by: 毛呆 <aweikalee@163.com> Co-authored-by: Dmitriy Mozgovoy <robotshara@gmail.com> Co-authored-by: Tom Ceuppens <t-c@live.be> Co-authored-by: Jelle Schutter <jelle@schutter.xyz> Co-authored-by: Rraji Abdelbari <57002508+estarossa0@users.noreply.github.com> Co-authored-by: Kirill Shakirov <kirill-shakirov@mail.ru> Co-authored-by: Shakirov Kirill <ksshakirov@sberautotech.ru> Co-authored-by: chenjigeng <178854407@qq.com> Co-authored-by: Dimitris Halatsis <dimitris_ha@hotmail.com> Co-authored-by: Johann Cooper <johanngcooper@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Victor Augusto <vdbernardes@gmail.com> Co-authored-by: João Gabriel Quaresma <j.quaresmasantos_98@hotmail.com>
Contributor
|
The case when error has type function test(err: AxiosError | Cancel) {
if (axios.isCancel(err)) {
err // AxiosError | Cancel
} else {
err // never
}
}I believe this's a bug. |
Contributor
|
My solution is remove Cancel interface and extend CanceledError export class CanceledError<T = any> extends AxiosError<T> {
+ private __CANCEL__: true;
}
- interface Cancel {
- message?: string;
- }
|
Merged
Tiphannie
pushed a commit
to Tiphannie/axios
that referenced
this pull request
Jul 4, 2025
Co-authored-by: Jay <jasonsaayman@gmail.com>
Tiphannie
pushed a commit
to Tiphannie/axios
that referenced
this pull request
Jul 4, 2025
Co-authored-by: Jay <jasonsaayman@gmail.com>
Tiphannie
pushed a commit
to Tiphannie/axios
that referenced
this pull request
Jul 4, 2025
Co-authored-by: Jay <jasonsaayman@gmail.com>
Tiphannie
pushed a commit
to Tiphannie/axios
that referenced
this pull request
Jul 4, 2025
Co-authored-by: Jay <jasonsaayman@gmail.com>
Tiphannie
pushed a commit
to Tiphannie/axios
that referenced
this pull request
Jul 4, 2025
Co-authored-by: Jay <jasonsaayman@gmail.com>
This was referenced Oct 27, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
add isCancel type assert