fix(types): align cjs cancelToken types#7414
Merged
jasonsaayman merged 3 commits intoaxios:v1.xfrom Apr 26, 2026
Merged
Conversation
the import/esm types include `undefined` (ref: https://github.com/axios/axios/blob/v1.x/index.d.ts#L457) this was added recently in axios#5560 - but only to `index.d.ts`, which can break type-checking in projects using a mixture of cjs and esm, when `exactOptionalPropertyTypes` is enabled, as it makes the request config types incompatible with eachother. you can see an example of the type error / this patch resolving it on mnahkies/openapi-code-generator#427
mnahkies
added a commit
to mnahkies/openapi-code-generator
that referenced
this pull request
Feb 18, 2026
bumping axios without this patch leads to type checking errors as seen here https://github.com/mnahkies/openapi-code-generator/actions/runs/22118781975/job/63933672790 ``` ... The types of 'config.transformRequest' are incompatible between these types. Type 'import("/home/runner/work/openapi-code-generator/openapi-code-generator/node_modules/.pnpm/axios@1.13.5/node_modules/axios/index").AxiosRequestTransformer | import("/home/runner/work/openapi-code-generator/openapi-code-generator/node_modules/.pnpm/axios@1.13.5/node_modules/axios/index").AxiosRequestTransformer[]' is not assignable to type 'import("/home/runner/work/openapi-code-generator/openapi-code-generator/node_modules/.pnpm/axios@1.13.5/node_modules/axios/index", { with: { "resolution-mode": "import" } }).AxiosRequestTransformer | import("/home/runner/work/openapi-code-generator/openapi-code-generator/node_modules/.pnpm/axios@1.13.5/node_modules/...'. Type 'AxiosRequestTransformer' is not assignable to type 'AxiosRequestTransformer | AxiosRequestTransformer[]'. Type 'import("/home/runner/work/openapi-code-generator/openapi-code-generator/node_modules/.pnpm/axios@1.13.5/node_modules/axios/index").AxiosRequestTransformer' is not assignable to type 'import("/home/runner/work/openapi-code-generator/openapi-code-generator/node_modules/.pnpm/axios@1.13.5/node_modules/axios/index", { with: { "resolution-mode": "import" } }).AxiosRequestTransformer'. The 'this' types of each signature are incompatible. Type 'import("/home/runner/work/openapi-code-generator/openapi-code-generator/node_modules/.pnpm/axios@1.13.5/node_modules/axios/index", { with: { "resolution-mode": "import" } }).InternalAxiosRequestConfig<any>' is not assignable to type 'import("/home/runner/work/openapi-code-generator/openapi-code-generator/node_modules/.pnpm/axios@1.13.5/node_modules/axios/index").InternalAxiosRequestConfig<any>' with 'exactOptionalPropertyTypes: true'. Consider adding 'undefined' to the types of the target's properties. Types of property 'transformRequest' are incompatible. Type 'import("/home/runner/work/openapi-code-generator/openapi-code-generator/node_modules/.pnpm/axios@1.13.5/node_modules/axios/index", { with: { "resolution-mode": "import" } }).AxiosRequestTransformer | import("/home/runner/work/openapi-code-generator/openapi-code-generator/node_modules/.pnpm/axios@1.13.5/node_modules/...' is not assignable to type 'import("/home/runner/work/openapi-code-generator/openapi-code-generator/node_modules/.pnpm/axios@1.13.5/node_modules/axios/index").AxiosRequestTransformer | import("/home/runner/work/openapi-code-generator/openapi-code-generator/node_modules/.pnpm/axios@1.13.5/node_modules/axios/index").AxiosRequestTransformer[]'. Type 'AxiosRequestTransformer' is not assignable to type 'AxiosRequestTransformer | AxiosRequestTransformer[]'. ``` The message is obtuse, but ultimately it's caused by axios/axios#5560 creating an incompatibility between the cjs and esm typings. Upstream fix submitted: axios/axios#7414 --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
jasonsaayman
approved these changes
Apr 26, 2026
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
2 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.
the import/esm types include
undefined(ref: https://github.com/axios/axios/blob/v1.x/index.d.ts#L457)this was added recently in #5560 - but only to
index.d.ts, which can break type-checking in projects using a mixture of cjs and esm, whenexactOptionalPropertyTypesis enabled, as it makes the request config types incompatible with each-other.you can see an example of the type error / this patch resolving it on mnahkies/openapi-code-generator#427
Summary by cubic
Aligns the CJS
AxiosRequestConfig.cancelTokentype with ESM by adding| undefinedinindex.d.cts. Prevents TypeScript assignability errors in mixed CJS/ESM projects withexactOptionalPropertyTypesenabled.Description
index.d.ctstocancelToken?: CancelToken | undefined(matchesindex.d.tsinaxios).exactOptionalPropertyTypesis on.Testing
AxiosRequestConfigare mutually assignable withexactOptionalPropertyTypes: true.Written for commit 9f51f1b. Summary will update on new commits.