fix(types): change the type guard on isCancel #5595
Conversation
This file contains 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
… to `CanceledError<any>`. This makes more sense as it reflects what `isCancel` is actually doing. In fact, if I'm not mistaken, the `Cancel` type is no longer in the project. It got removed in 7f12366. It should probably also be removed from the types.
|
Encountered this problem too. @DigitalBrainJS Mind taking a look at this PR when you're free? The 
|
|
Also /cc @jasonsaayman @mzabriskie. Thanks for the effort you put into this. |
|
Hi! I have same issue So i need to put my cancel condition after all code in function, but it is not my desired solution. |
samavati
suggested changes
Oct 20, 2023
Thanks to @samavati for the suggestion. Co-authored-by: Ehsan Samavati <samaavaati@gmail.com>
Thanks for your suggestion! I've added it to the PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This fixes #5153.
Change the type guard on
isCanceltoCanceledError<any>. This makes more sense as it reflects whatisCancelis actually doing. In fact, if I'm not mistaken, theCanceltype is no longer in the project. It got removed in 7f12366. It should probably also be removed from the types, but I didn't do it in this PR, as I wanted to keep the change minimal.I needed to declare
nameonCanceledErrorbecause the typesCanceledErrorandAxiosErrorneed to be structurally different from each other in order for the type guard onisCancelto work properly. From the point of view of TypeScript, declaringCanceledErrorwithout introducing some new structure is a mistake, as both types are essentially aliases now. (TS is a structural typing system.) I did not opt to make__CANCEL__: booleanpart ofCanceledError's structure, as that seemed counterintuitive. I don't think users of this library should necessarily know it exists or rely on its existence.