fix(types): allow to specify partial default headers for instance cre…

…ation (#4185) Co-authored-by: Jay <jasonsaayman@gmail.com>
axios · May 9, 2022 · ac96144 · ac96144
1 parent 356b166
commit ac96144
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/index.d.ts b/index.d.ts
@@ -137,6 +137,10 @@ export interface AxiosDefaults<D = any> extends Omit<AxiosRequestConfig<D>, 'hea
   headers: HeadersDefaults;
 }
 
+export interface CreateAxiosDefaults<D = any> extends Omit<AxiosRequestConfig<D>, 'headers'> {
+  headers?: AxiosRequestHeaders | Partial<HeadersDefaults>;
+}
+
 export interface AxiosResponse<T = any, D = any>  {
   data: T;
   status: number;
@@ -254,7 +258,7 @@ export interface GenericFormData {
 }
 
 export interface AxiosStatic extends AxiosInstance {
-  create(config?: AxiosRequestConfig): AxiosInstance;
+  create(config?: CreateAxiosDefaults): AxiosInstance;
   Cancel: CancelStatic;
   CancelToken: CancelTokenStatic;
   Axios: typeof Axios;

diff --git a/test/typescript/axios.ts b/test/typescript/axios.ts
@@ -263,6 +263,11 @@ instance1.defaults.headers.common['Authorization'] = 'token';
 instance1.defaults.headers.post['X-FOO'] = 'bar';
 instance1.defaults.timeout = 2500;
 
+// axios create defaults
+
+axios.create({ headers: { foo: 'bar' } });
+axios.create({ headers: { common: { foo: 'bar' } } });
+
 // Interceptors
 
 const requestInterceptorId: number = axios.interceptors.request.use(