feat(backport): added ability for paramsSerializer to handle function; (

#6227)
axios · Feb 12, 2024 · 27c0076 · 27c0076
1 parent 80c3d74
commit 27c0076
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/index.d.ts b/index.d.ts
@@ -122,6 +122,10 @@ export interface ParamEncoder {
   (value: any, defaultEncoder: (value: any) => any): any;
 }
 
+export interface CustomParamsSerializer {
+  (params: Record<string, any>, options?: ParamsSerializerOptions): string;
+}
+
 export interface ParamsSerializerOptions extends SerializerOptions {
   encode?: ParamEncoder;
 }
@@ -134,7 +138,7 @@ export interface AxiosRequestConfig<D = any> {
   transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[];
   headers?: AxiosRequestHeaders;
   params?: any;
-  paramsSerializer?: ParamsSerializerOptions;
+  paramsSerializer?: ParamsSerializerOptions | CustomParamsSerializer;
   data?: D;
   timeout?: number;
   timeoutErrorMessage?: string;

diff --git a/lib/core/Axios.js b/lib/core/Axios.js
@@ -59,6 +59,10 @@ Axios.prototype.request = function request(configOrUrl, config) {
     }, false);
   }
 
+  var paramsSerializer = config.paramsSerializer;
+
+  utils.isFunction(paramsSerializer) && (config.paramsSerializer = {serialize: paramsSerializer});
+
   // filter out skipped interceptors
   var requestInterceptorChain = [];
   var synchronousRequestInterceptors = true;