fix(types): align interceptor handler runWhen typing#7464
Open
theamodhshetty wants to merge 1 commit intoaxios:v1.xfrom
Open
fix(types): align interceptor handler runWhen typing#7464theamodhshetty wants to merge 1 commit intoaxios:v1.xfrom
theamodhshetty wants to merge 1 commit intoaxios:v1.xfrom
Conversation
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
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.
Summary
This fixes an inconsistency between request interceptor option typing and the internal request interceptor handler typing.
Before this change:
AxiosInterceptorOptions['runWhen']was typed as(config: InternalAxiosRequestConfig) => booleanAxiosInterceptorManager['handlers'][number]['runWhen']was typed differently inindex.d.ts/index.d.ctsThat mismatch can cause assignability issues when working with
AxiosInstancetypes across module boundaries.This patch:
AxiosInterceptorHandler['runWhen']toAxiosInterceptorOptions['runWhen'] | nullin bothindex.d.tsandindex.d.ctsrunWhentypes stay compatibleFixes #7404.
Testing
npm test --prefix test/module/typings/esmnpm test --prefix test/module/typings/cjsSummary by cubic
Aligns the interceptor handler runWhen type with AxiosInterceptorOptions to prevent assignability errors across module boundaries. Adds ESM and CJS typing tests to lock the contract.
Description
Docs
No docs changes needed. This only aligns TypeScript typings.
Testing
Written for commit 8ec423f. Summary will update on new commits.