fix: Type of header in AxiosRequestConfig is incorrect

The type of the headers property in Axios.create config has not support headers for specific requests method (or common). Closes axios#4911
WillianAgostini · Aug 21, 2022 · abca2b6 · abca2b6
1 parent 66d4780
commit abca2b6
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/index.d.ts b/index.d.ts
@@ -1,5 +1,11 @@
 // TypeScript Version: 4.1
-type AxiosHeaders = Record<string, string | string[] | number | boolean>;
+type JSONValue = string | string[] | number | boolean;
+
+interface JSONObject {
+  [x: string]: JSONValue;
+}
+
+type AxiosHeaders = Record<string, JSONValue | JSONObject>;
 
 type MethodsHeaders = {
   [Key in Method as Lowercase<Key>]: AxiosHeaders;

diff --git a/test/typescript/axios.ts b/test/typescript/axios.ts
@@ -162,6 +162,10 @@ axios.post<User>('/user', { name: 'foo', id: 1 }, { headers: { 'X-FOO': 'bar' }
 	.then(handleUserResponse)
 	.catch(handleError);
 
+axios.post<User>('/user', { name: 'foo', id: 1 }, { headers: { get: { 'X-FOO': 'bar' }} })
+	.then(handleUserResponse) 
+	.catch(handleError);
+
 axios.put<User>('/user', { name: 'foo', id: 1 })
 	.then(handleUserResponse)
 	.catch(handleError);