mirrors/axios
2
0
Fork 0
mirror of https://github.com/tenrok/axios.git synced 2026-06-20 20:00:40 +03:00
Code Activity

fix(types): fixed AxiosRequestConfig header interface by refactoring it to RawAxiosRequestConfig; (#5420)

Browse Source
This commit is contained in:
Dmitriy Mozgovoy
2023-01-06 02:02:08 +02:00
committed by GitHub
parent 8651bf17d4
commit 08119634a2
5 changed files with 250 additions and 231 deletions
Download Patch File Download Diff File Expand all files Collapse all files
index.d.cts
+23 -19
View File
@@ -103,24 +103,24 @@ declare class CanceledError<T> extends AxiosError<T> {
} }
declare class Axios { declare class Axios {
constructor(config?: axios.AxiosRequestConfig); constructor(config?: axios.RawAxiosRequestConfig);
defaults: axios.AxiosDefaults; defaults: axios.AxiosDefaults;
interceptors: { interceptors: {
request: axios.AxiosInterceptorManager<axios.AxiosRequestConfig>; request: axios.AxiosInterceptorManager<axios.AxiosRequestConfig>;
response: axios.AxiosInterceptorManager<axios.AxiosResponse>; response: axios.AxiosInterceptorManager<axios.AxiosResponse>;
}; };
getUri(config?: axios.AxiosRequestConfig): string; getUri(config?: axios.RawAxiosRequestConfig): string;
request<T = any, R = axios.AxiosResponse<T>, D = any>(config: axios.AxiosRequestConfig<D>): Promise<R>; request<T = any, R = axios.AxiosResponse<T>, D = any>(config: axios.RawAxiosRequestConfig<D>): Promise<R>;
get<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, config?: axios.AxiosRequestConfig<D>): Promise<R>; get<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, config?: axios.RawAxiosRequestConfig<D>): Promise<R>;
delete<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, config?: axios.AxiosRequestConfig<D>): Promise<R>; delete<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, config?: axios.RawAxiosRequestConfig<D>): Promise<R>;
head<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, config?: axios.AxiosRequestConfig<D>): Promise<R>; head<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, config?: axios.RawAxiosRequestConfig<D>): Promise<R>;
options<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, config?: axios.AxiosRequestConfig<D>): Promise<R>; options<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, config?: axios.RawAxiosRequestConfig<D>): Promise<R>;
post<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, data?: D, config?: axios.AxiosRequestConfig<D>): Promise<R>; post<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, data?: D, config?: axios.RawAxiosRequestConfig<D>): Promise<R>;
put<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, data?: D, config?: axios.AxiosRequestConfig<D>): Promise<R>; put<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, data?: D, config?: axios.RawAxiosRequestConfig<D>): Promise<R>;
patch<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, data?: D, config?: axios.AxiosRequestConfig<D>): Promise<R>; patch<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, data?: D, config?: axios.RawAxiosRequestConfig<D>): Promise<R>;
postForm<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, data?: D, config?: axios.AxiosRequestConfig<D>): Promise<R>; postForm<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, data?: D, config?: axios.RawAxiosRequestConfig<D>): Promise<R>;
putForm<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, data?: D, config?: axios.AxiosRequestConfig<D>): Promise<R>; putForm<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, data?: D, config?: axios.RawAxiosRequestConfig<D>): Promise<R>;
patchForm<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, data?: D, config?: axios.AxiosRequestConfig<D>): Promise<R>; patchForm<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, data?: D, config?: axios.RawAxiosRequestConfig<D>): Promise<R>;
} }
declare enum HttpStatusCode { declare enum HttpStatusCode {
@@ -342,7 +342,7 @@ declare namespace axios {
type AxiosAdapterConfig = AxiosAdapter | AxiosAdapterName; type AxiosAdapterConfig = AxiosAdapter | AxiosAdapterName;
interface AxiosRequestConfig<D = any> { interface RawAxiosRequestConfig<D = any> {
url?: string; url?: string;
method?: Method | string; method?: Method | string;
baseURL?: string; baseURL?: string;
@@ -384,6 +384,10 @@ declare namespace axios {
formSerializer?: FormSerializerOptions; formSerializer?: FormSerializerOptions;
} }
interface AxiosRequestConfig<D = any> extends RawAxiosRequestConfig {
headers: AxiosRequestHeaders;
}
interface HeadersDefaults { interface HeadersDefaults {
common: RawAxiosRequestHeaders; common: RawAxiosRequestHeaders;
delete: RawAxiosRequestHeaders; delete: RawAxiosRequestHeaders;
@@ -398,11 +402,11 @@ declare namespace axios {
unlink?: RawAxiosRequestHeaders; unlink?: RawAxiosRequestHeaders;
} }
interface AxiosDefaults<D = any> extends Omit<AxiosRequestConfig<D>, 'headers'> { interface AxiosDefaults<D = any> extends Omit<RawAxiosRequestConfig<D>, 'headers'> {
headers: HeadersDefaults; headers: HeadersDefaults;
} }
interface CreateAxiosDefaults<D = any> extends Omit<AxiosRequestConfig<D>, 'headers'> { interface CreateAxiosDefaults<D = any> extends Omit<RawAxiosRequestConfig<D>, 'headers'> {
headers?: RawAxiosRequestHeaders | AxiosHeaders | Partial<HeadersDefaults>; headers?: RawAxiosRequestHeaders | AxiosHeaders | Partial<HeadersDefaults>;
} }
@@ -426,7 +430,7 @@ declare namespace axios {
} }
interface Canceler { interface Canceler {
(message?: string, config?: AxiosRequestConfig, request?: any): void; (message?: string, config?: RawAxiosRequestConfig, request?: any): void;
} }
interface CancelTokenStatic { interface CancelTokenStatic {
@@ -457,8 +461,8 @@ declare namespace axios {
} }
interface AxiosInstance extends Axios { interface AxiosInstance extends Axios {
<T = any, R = AxiosResponse<T>, D = any>(config: AxiosRequestConfig<D>): Promise<R>; <T = any, R = AxiosResponse<T>, D = any>(config: RawAxiosRequestConfig<D>): Promise<R>;
<T = any, R = AxiosResponse<T>, D = any>(url: string, config?: AxiosRequestConfig<D>): Promise<R>; <T = any, R = AxiosResponse<T>, D = any>(url: string, config?: RawAxiosRequestConfig<D>): Promise<R>;
defaults: Omit<AxiosDefaults, 'headers'> & { defaults: Omit<AxiosDefaults, 'headers'> & {
headers: HeadersDefaults & { headers: HeadersDefaults & {
index.d.ts
Vendored
+23 -19
View File
@@ -283,7 +283,7 @@ type AxiosAdapterName = 'xhr' | 'http' | string;
type AxiosAdapterConfig = AxiosAdapter | AxiosAdapterName; type AxiosAdapterConfig = AxiosAdapter | AxiosAdapterName;
export interface AxiosRequestConfig<D = any> { export interface RawAxiosRequestConfig<D = any> {
url?: string; url?: string;
method?: Method | string; method?: Method | string;
baseURL?: string; baseURL?: string;
@@ -325,6 +325,10 @@ export interface AxiosRequestConfig<D = any> {
formSerializer?: FormSerializerOptions; formSerializer?: FormSerializerOptions;
} }
export interface AxiosRequestConfig<D = any> extends RawAxiosRequestConfig {
headers: AxiosRequestHeaders;
}
export interface HeadersDefaults { export interface HeadersDefaults {
common: RawAxiosRequestHeaders; common: RawAxiosRequestHeaders;
delete: RawAxiosRequestHeaders; delete: RawAxiosRequestHeaders;
@@ -339,11 +343,11 @@ export interface HeadersDefaults {
unlink?: RawAxiosRequestHeaders; unlink?: RawAxiosRequestHeaders;
} }
export interface AxiosDefaults<D = any> extends Omit<AxiosRequestConfig<D>, 'headers'> { export interface AxiosDefaults<D = any> extends Omit<RawAxiosRequestConfig<D>, 'headers'> {
headers: HeadersDefaults; headers: HeadersDefaults;
} }
export interface CreateAxiosDefaults<D = any> extends Omit<AxiosRequestConfig<D>, 'headers'> { export interface CreateAxiosDefaults<D = any> extends Omit<RawAxiosRequestConfig<D>, 'headers'> {
headers?: RawAxiosRequestHeaders | AxiosHeaders | Partial<HeadersDefaults>; headers?: RawAxiosRequestHeaders | AxiosHeaders | Partial<HeadersDefaults>;
} }
@@ -409,7 +413,7 @@ export interface Cancel {
} }
export interface Canceler { export interface Canceler {
(message?: string, config?: AxiosRequestConfig, request?: any): void; (message?: string, config?: RawAxiosRequestConfig, request?: any): void;
} }
export interface CancelTokenStatic { export interface CancelTokenStatic {
@@ -440,29 +444,29 @@ export interface AxiosInterceptorManager<V> {
} }
export class Axios { export class Axios {
constructor(config?: AxiosRequestConfig); constructor(config?: RawAxiosRequestConfig);
defaults: AxiosDefaults; defaults: AxiosDefaults;
interceptors: { interceptors: {
request: AxiosInterceptorManager<AxiosRequestConfig>; request: AxiosInterceptorManager<AxiosRequestConfig>;
response: AxiosInterceptorManager<AxiosResponse>; response: AxiosInterceptorManager<AxiosResponse>;
}; };
getUri(config?: AxiosRequestConfig): string; getUri(config?: RawAxiosRequestConfig): string;
request<T = any, R = AxiosResponse<T>, D = any>(config: AxiosRequestConfig<D>): Promise<R>; request<T = any, R = AxiosResponse<T>, D = any>(config: RawAxiosRequestConfig<D>): Promise<R>;
get<T = any, R = AxiosResponse<T>, D = any>(url: string, config?: AxiosRequestConfig<D>): Promise<R>; get<T = any, R = AxiosResponse<T>, D = any>(url: string, config?: RawAxiosRequestConfig<D>): Promise<R>;
delete<T = any, R = AxiosResponse<T>, D = any>(url: string, config?: AxiosRequestConfig<D>): Promise<R>; delete<T = any, R = AxiosResponse<T>, D = any>(url: string, config?: RawAxiosRequestConfig<D>): Promise<R>;
head<T = any, R = AxiosResponse<T>, D = any>(url: string, config?: AxiosRequestConfig<D>): Promise<R>; head<T = any, R = AxiosResponse<T>, D = any>(url: string, config?: RawAxiosRequestConfig<D>): Promise<R>;
options<T = any, R = AxiosResponse<T>, D = any>(url: string, config?: AxiosRequestConfig<D>): Promise<R>; options<T = any, R = AxiosResponse<T>, D = any>(url: string, config?: RawAxiosRequestConfig<D>): Promise<R>;
post<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: AxiosRequestConfig<D>): Promise<R>; post<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: RawAxiosRequestConfig<D>): Promise<R>;
put<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: AxiosRequestConfig<D>): Promise<R>; put<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: RawAxiosRequestConfig<D>): Promise<R>;
patch<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: AxiosRequestConfig<D>): Promise<R>; patch<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: RawAxiosRequestConfig<D>): Promise<R>;
postForm<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: AxiosRequestConfig<D>): Promise<R>; postForm<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: RawAxiosRequestConfig<D>): Promise<R>;
putForm<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: AxiosRequestConfig<D>): Promise<R>; putForm<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: RawAxiosRequestConfig<D>): Promise<R>;
patchForm<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: AxiosRequestConfig<D>): Promise<R>; patchForm<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: RawAxiosRequestConfig<D>): Promise<R>;
} }
export interface AxiosInstance extends Axios { export interface AxiosInstance extends Axios {
<T = any, R = AxiosResponse<T>, D = any>(config: AxiosRequestConfig<D>): Promise<R>; <T = any, R = AxiosResponse<T>, D = any>(config: RawAxiosRequestConfig<D>): Promise<R>;
<T = any, R = AxiosResponse<T>, D = any>(url: string, config?: AxiosRequestConfig<D>): Promise<R>; <T = any, R = AxiosResponse<T>, D = any>(url: string, config?: RawAxiosRequestConfig<D>): Promise<R>;
defaults: Omit<AxiosDefaults, 'headers'> & { defaults: Omit<AxiosDefaults, 'headers'> & {
headers: HeadersDefaults & { headers: HeadersDefaults & {
test/module/test.js
+3
View File
@@ -58,6 +58,8 @@ describe('module', function () {
await remove(BACKUP_PATH); await remove(BACKUP_PATH);
}); });
describe('export', function () {
it('should have consistent ESM export', function () { it('should have consistent ESM export', function () {
const namedExport = {}; const namedExport = {};
const factoryExport = {}; const factoryExport = {};
@@ -144,6 +146,7 @@ describe('module', function () {
await exec(`npm test --prefix ${pkgPath}`, {}); await exec(`npm test --prefix ${pkgPath}`, {});
}); });
}); });
});
describe('typings', () => { describe('typings', () => {
describe('ESM', ()=> { describe('ESM', ()=> {
test/module/typings/cjs/index.ts
+3 -3
View File
@@ -1,6 +1,6 @@
import axios = require('axios'); import axios = require('axios');
const config: axios.AxiosRequestConfig = { const config: axios.RawAxiosRequestConfig = {
url: '/user', url: '/user',
method: 'get', method: 'get',
baseURL: 'https://api.example.com/', baseURL: 'https://api.example.com/',
@@ -38,11 +38,11 @@ const config: axios.AxiosRequestConfig = {
cancelToken: new axios.CancelToken((cancel: axios.Canceler) => {}) cancelToken: new axios.CancelToken((cancel: axios.Canceler) => {})
}; };
const nullValidateStatusConfig: axios.AxiosRequestConfig = { const nullValidateStatusConfig: axios.RawAxiosRequestConfig = {
validateStatus: null validateStatus: null
}; };
const undefinedValidateStatusConfig: axios.AxiosRequestConfig = { const undefinedValidateStatusConfig: axios.RawAxiosRequestConfig = {
validateStatus: undefined validateStatus: undefined
}; };
test/module/typings/esm/index.ts
+18 -10
View File
@@ -1,4 +1,5 @@
import axios, { import axios, {
RawAxiosRequestConfig,
AxiosRequestConfig, AxiosRequestConfig,
AxiosHeaders, AxiosHeaders,
AxiosRequestHeaders, AxiosRequestHeaders,
@@ -21,7 +22,7 @@ import axios, {
spread spread
} from 'axios'; } from 'axios';
const config: AxiosRequestConfig = { const config: RawAxiosRequestConfig = {
url: '/user', url: '/user',
method: 'get', method: 'get',
baseURL: 'https://api.example.com/', baseURL: 'https://api.example.com/',
@@ -59,11 +60,11 @@ const config: AxiosRequestConfig = {
cancelToken: new axios.CancelToken((cancel: Canceler) => {}) cancelToken: new axios.CancelToken((cancel: Canceler) => {})
}; };
const nullValidateStatusConfig: AxiosRequestConfig = { const nullValidateStatusConfig: RawAxiosRequestConfig = {
validateStatus: null validateStatus: null
}; };
const undefinedValidateStatusConfig: AxiosRequestConfig = { const undefinedValidateStatusConfig: RawAxiosRequestConfig = {
validateStatus: undefined validateStatus: undefined
}; };
@@ -297,7 +298,7 @@ axios.create({
// Interceptors // Interceptors
const requestInterceptorId: number = axios.interceptors.request.use( const requestInterceptorId: number = axios.interceptors.request.use(
async (config: AxiosRequestConfig) => { async (config) => {
await axios.get('/foo', { await axios.get('/foo', {
headers: config.headers headers: config.headers
}); });
@@ -310,12 +311,12 @@ const requestInterceptorId: number = axios.interceptors.request.use(
axios.interceptors.request.eject(requestInterceptorId); axios.interceptors.request.eject(requestInterceptorId);
axios.interceptors.request.use( axios.interceptors.request.use(
(config: AxiosRequestConfig) => Promise.resolve(config), (config) => Promise.resolve(config),
(error: any) => Promise.reject(error) (error: any) => Promise.reject(error)
); );
axios.interceptors.request.use((config: AxiosRequestConfig) => config); axios.interceptors.request.use((config) => config);
axios.interceptors.request.use((config: AxiosRequestConfig) => Promise.resolve(config)); axios.interceptors.request.use((config) => Promise.resolve(config));
const responseInterceptorId: number = axios.interceptors.response.use( const responseInterceptorId: number = axios.interceptors.response.use(
(response: AxiosResponse) => response, (response: AxiosResponse) => response,
@@ -329,6 +330,13 @@ axios.interceptors.response.use(
(error: any) => Promise.reject(error) (error: any) => Promise.reject(error)
); );
axios.interceptors.request.use(req => {
// https://github.com/axios/axios/issues/5415
req.headers.set('foo', 'bar');
req.headers['Content-Type'] = 123;
return req;
});
const voidRequestInterceptorId = axios.interceptors.request.use( const voidRequestInterceptorId = axios.interceptors.request.use(
// @ts-expect-error -- Must return an AxiosRequestConfig (or throw) // @ts-expect-error -- Must return an AxiosRequestConfig (or throw)
(_response) => {}, (_response) => {},
@@ -350,7 +358,7 @@ axios.interceptors.response.clear();
// Adapters // Adapters
const adapter: AxiosAdapter = (config: AxiosRequestConfig) => { const adapter: AxiosAdapter = (config) => {
const response: AxiosResponse = { const response: AxiosResponse = {
data: { foo: 'bar' }, data: { foo: 'bar' },
status: 200, status: 200,
@@ -507,7 +515,7 @@ axios.get('/user', {
// issue #5034 // issue #5034
function getRequestConfig1(options: AxiosRequestConfig): AxiosRequestConfig { function getRequestConfig1(options: RawAxiosRequestConfig): RawAxiosRequestConfig {
return { return {
...options, ...options,
headers: { headers: {
@@ -517,7 +525,7 @@ function getRequestConfig1(options: AxiosRequestConfig): AxiosRequestConfig {
}; };
} }
function getRequestConfig2(options: AxiosRequestConfig): AxiosRequestConfig { function getRequestConfig2(options: RawAxiosRequestConfig): RawAxiosRequestConfig {
return { return {
...options, ...options,
headers: { headers: {