Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fix transformRequest input typing #10745

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jasonsaayman merged 5 commits into from
Apr 26, 2026
Merged

fix transformRequest input typing #10745

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
af4c572
fix(types): type transformRequest input data
atharvasingh7007 Apr 17, 2026
38adbbd
Merge branch 'v1.x' into codex/fix-request-transformer-input-typing
jasonsaayman Apr 25, 2026
f5a1fa9
chore: imrpove testing and overall posture
jasonsaayman Apr 25, 2026
0ea4d49
Merge branch 'v1.x' into codex/fix-request-transformer-input-typing
jasonsaayman Apr 25, 2026
3228da4
fix:f failing tests
jasonsaayman Apr 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions index.d.cts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,14 +320,14 @@ declare namespace axios {

type AxiosResponseHeaders = RawAxiosResponseHeaders & AxiosHeaders;

interface AxiosRequestTransformer {
(this: InternalAxiosRequestConfig, data: any, headers: AxiosRequestHeaders): any;
interface AxiosRequestTransformer<D = any> {
(this: InternalAxiosRequestConfig<D>, data: D, headers: AxiosRequestHeaders): any;
}

interface AxiosResponseTransformer {
interface AxiosResponseTransformer<T = any> {
(
this: InternalAxiosRequestConfig,
data: any,
data: T,
headers: AxiosResponseHeaders,
status?: number
): any;
Expand Down Expand Up @@ -471,7 +471,7 @@ declare namespace axios {
method?: Method | string;
baseURL?: string;
allowAbsoluteUrls?: boolean;
transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[];
transformRequest?: AxiosRequestTransformer<D> | AxiosRequestTransformer<D>[];
transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[];
headers?: (RawAxiosRequestHeaders & MethodsHeaders) | AxiosHeaders;
params?: any;
Expand Down
10 changes: 5 additions & 5 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,14 +138,14 @@ export type RawAxiosResponseHeaders = Partial<RawAxiosHeaders & RawCommonRespons

export type AxiosResponseHeaders = RawAxiosResponseHeaders & AxiosHeaders;

export interface AxiosRequestTransformer {
(this: InternalAxiosRequestConfig, data: any, headers: AxiosRequestHeaders): any;
export interface AxiosRequestTransformer<D = any> {
(this: InternalAxiosRequestConfig<D>, data: D, headers: AxiosRequestHeaders): any;
}

export interface AxiosResponseTransformer {
export interface AxiosResponseTransformer<T = any> {
(
this: InternalAxiosRequestConfig,
data: any,
data: T,
headers: AxiosResponseHeaders,
status?: number
): any;
Expand Down Expand Up @@ -367,7 +367,7 @@ export interface AxiosRequestConfig<D = any> {
method?: StringLiteralsOrString<Method>;
baseURL?: string;
allowAbsoluteUrls?: boolean;
transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[];
transformRequest?: AxiosRequestTransformer<D> | AxiosRequestTransformer<D>[];
transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[];
headers?: (RawAxiosRequestHeaders & MethodsHeaders) | AxiosHeaders;
params?: any;
Expand Down
8 changes: 7 additions & 1 deletion tests/module/cjs/tests/helpers/fixture.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
const fs = require('fs');
const path = require('path');

const createTempFixture = (suiteRoot, name, sourcePath, tsconfig, packageJson) => {
const createTempFixture = (suiteRoot, repoRoot, name, sourcePath, tsconfig, packageJson) => {
const tempRoot = fs.mkdtempSync(path.join(suiteRoot, `.tmp-module-${name}-`));
const source = fs.readFileSync(sourcePath, 'utf8');

fs.writeFileSync(path.join(tempRoot, 'index.ts'), source);
fs.writeFileSync(path.join(tempRoot, 'tsconfig.json'), JSON.stringify(tsconfig, null, 2));

if (repoRoot) {
const axiosFixturePath = path.join(tempRoot, 'node_modules', 'axios');
fs.mkdirSync(path.dirname(axiosFixturePath), { recursive: true });
fs.symlinkSync(repoRoot, axiosFixturePath, 'junction');
}

if (packageJson) {
fs.writeFileSync(path.join(tempRoot, 'package.json'), JSON.stringify(packageJson, null, 2));
}
Expand Down
52 changes: 52 additions & 0 deletions tests/module/cjs/tests/helpers/transform-request-typing.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
import axios = require('axios');

type Payload = {
foo: string;
count: number;
};

type OtherPayload = {
other: number;
};

const transformer: axios.AxiosRequestTransformer<Payload> = function (data, headers) {
headers.setContentType('application/json');
data.foo.toUpperCase();
data.count.toFixed();

// `this` is narrowed to InternalAxiosRequestConfig<Payload>, so this.data is Payload
this.data?.foo.toUpperCase();
this.data?.count.toFixed();
// @ts-expect-error this.data is Payload, not OtherPayload
this.data?.other;

// @ts-expect-error property does not exist on Payload
data.bar;

return JSON.stringify(data);
};

const wrongTransformer: axios.AxiosRequestTransformer<OtherPayload> = (data) => JSON.stringify(data);

const config: axios.AxiosRequestConfig<Payload> = {
data: {
foo: 'hello',
count: 1,
},
transformRequest: [
transformer,
(data) => {
data.foo.toUpperCase();
data.count.toFixed();

// @ts-expect-error property does not exist on Payload
data.bar;

return JSON.stringify(data);
},
// @ts-expect-error transformer payload type does not match config D
wrongTransformer,
],
};

void axios.request(config);
8 changes: 7 additions & 1 deletion tests/module/cjs/tests/ts-require-default.module.test.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,13 @@ const tsconfig = {
describe('module ts-require-default compatibility', () => {
it('compiles and executes require("axios").default imports', () => {
const sourcePath = path.join(repoRoot, 'tests/module/cjs/tests/helpers/ts-require-default.ts');
const fixturePath = createTempFixture(suiteRoot, 'ts-require-default', sourcePath, tsconfig);
const fixturePath = createTempFixture(
suiteRoot,
null,
Comment thread
jasonsaayman marked this conversation as resolved.
'ts-require-default',
sourcePath,
tsconfig
);

try {
runCommand('node', [tscBin, '-p', 'tsconfig.json'], { cwd: fixturePath });
Expand Down
2 changes: 1 addition & 1 deletion tests/module/cjs/tests/ts-require.module.test.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const tsconfig = {
describe('module ts-require compatibility', () => {
it('compiles and executes require("axios") imports', () => {
const sourcePath = path.join(repoRoot, 'tests/module/cjs/tests/helpers/ts-require.ts');
const fixturePath = createTempFixture(suiteRoot, 'ts-require', sourcePath, tsconfig);
const fixturePath = createTempFixture(suiteRoot, null, 'ts-require', sourcePath, tsconfig);

try {
runCommand('node', [tscBin, '-p', 'tsconfig.json'], { cwd: fixturePath });
Expand Down
22 changes: 21 additions & 1 deletion tests/module/cjs/tests/typings.module.test.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,27 @@ const tsconfig = {
describe('module cjs typings compatibility', () => {
it('type-checks commonjs axios typings', () => {
const sourcePath = path.join(repoRoot, 'tests/module/cjs/tests/helpers/cjs-typing.ts');
const fixturePath = createTempFixture(suiteRoot, 'typings-cjs', sourcePath, tsconfig);
const fixturePath = createTempFixture(suiteRoot, repoRoot, 'typings-cjs', sourcePath, tsconfig);

try {
runCommand('node', [tscBin, '--noEmit', '-p', 'tsconfig.json'], { cwd: fixturePath });
} finally {
cleanupTempFixture(fixturePath);
}
});

it('type-checks generic commonjs request transformer typings', () => {
const sourcePath = path.join(
repoRoot,
'tests/module/cjs/tests/helpers/transform-request-typing.ts'
);
const fixturePath = createTempFixture(
suiteRoot,
repoRoot,
'typings-cjs-transform-request',
sourcePath,
tsconfig
);

try {
runCommand('node', [tscBin, '--noEmit', '-p', 'tsconfig.json'], { cwd: fixturePath });
Expand Down
8 changes: 7 additions & 1 deletion tests/module/esm/tests/helpers/fixture.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
import fs from 'node:fs';
import path from 'node:path';

export const createTempFixture = (suiteRoot, name, sourcePath, tsconfig, packageJson) => {
export const createTempFixture = (suiteRoot, repoRoot, name, sourcePath, tsconfig, packageJson) => {
const tempRoot = fs.mkdtempSync(path.join(suiteRoot, `.tmp-module-${name}-`));
const source = fs.readFileSync(sourcePath, 'utf8');

fs.writeFileSync(path.join(tempRoot, 'index.ts'), source);
fs.writeFileSync(path.join(tempRoot, 'tsconfig.json'), JSON.stringify(tsconfig, null, 2));

if (repoRoot) {
const axiosFixturePath = path.join(tempRoot, 'node_modules', 'axios');
fs.mkdirSync(path.dirname(axiosFixturePath), { recursive: true });
fs.symlinkSync(repoRoot, axiosFixturePath, 'junction');
}

if (packageJson) {
fs.writeFileSync(path.join(tempRoot, 'package.json'), JSON.stringify(packageJson, null, 2));
}
Expand Down
52 changes: 52 additions & 0 deletions tests/module/esm/tests/helpers/transform-request-typing.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
import axios, { AxiosRequestConfig, AxiosRequestTransformer } from 'axios';

type Payload = {
foo: string;
count: number;
};

type OtherPayload = {
other: number;
};

const transformer: AxiosRequestTransformer<Payload> = function (data, headers) {
headers.setContentType('application/json');
data.foo.toUpperCase();
data.count.toFixed();

// `this` is narrowed to InternalAxiosRequestConfig<Payload>, so this.data is Payload
this.data?.foo.toUpperCase();
this.data?.count.toFixed();
// @ts-expect-error this.data is Payload, not OtherPayload
this.data?.other;

// @ts-expect-error property does not exist on Payload
data.bar;

return JSON.stringify(data);
};

const wrongTransformer: AxiosRequestTransformer<OtherPayload> = (data) => JSON.stringify(data);

const config: AxiosRequestConfig<Payload> = {
data: {
foo: 'hello',
count: 1,
},
transformRequest: [
transformer,
(data) => {
data.foo.toUpperCase();
data.count.toFixed();

// @ts-expect-error property does not exist on Payload
data.bar;

return JSON.stringify(data);
},
// @ts-expect-error transformer payload type does not match config D
wrongTransformer,
],
};

void axios.request(config);
2 changes: 1 addition & 1 deletion tests/module/esm/tests/ts.module.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ const tsconfig = {
describe('module ts compatibility', () => {
it('compiles and executes import axios syntax', () => {
const sourcePath = path.join(repoRoot, 'tests/module/esm/tests/helpers/esm-functions.ts');
const fixturePath = createTempFixture(suiteRoot, 'ts', sourcePath, tsconfig, {
const fixturePath = createTempFixture(suiteRoot, null, 'ts', sourcePath, tsconfig, {
Comment thread
jasonsaayman marked this conversation as resolved.
type: 'commonjs',
});

Expand Down
38 changes: 34 additions & 4 deletions tests/module/esm/tests/typings.module.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,41 @@ const tsconfig = {
};

describe('module esm typings compatibility', () => {
it('type-checks esm axios typings', () => {
it('type-checks esm axios typings', { timeout: 20000 }, () => {
const sourcePath = path.join(repoRoot, 'tests/module/esm/tests/helpers/esm-index.ts');
const fixturePath = createTempFixture(suiteRoot, 'typings-esm', sourcePath, tsconfig, {
type: 'module',
});
const fixturePath = createTempFixture(
suiteRoot,
repoRoot,
'typings-esm',
sourcePath,
tsconfig,
{
type: 'module',
}
);

try {
runCommand('node', [tscBin, '--noEmit', '-p', 'tsconfig.json'], { cwd: fixturePath });
} finally {
cleanupTempFixture(fixturePath);
}
});

it('type-checks generic request transformer typings', { timeout: 20000 }, () => {
const sourcePath = path.join(
repoRoot,
'tests/module/esm/tests/helpers/transform-request-typing.ts'
);
const fixturePath = createTempFixture(
suiteRoot,
repoRoot,
'typings-esm-transform-request',
sourcePath,
tsconfig,
{
type: 'module',
}
);

try {
runCommand('node', [tscBin, '--noEmit', '-p', 'tsconfig.json'], { cwd: fixturePath });
Expand Down
Loading