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

docs(paramsSerializer config within request config): update documentation for paramsSerializer

Co-authored-by: David Dallas <Davidcobb606@gmail.com>
Co-authored-by: Jay <jasonsaayman@gmail.com>
This commit is contained in:
David Dallas
2023-09-07 15:59:17 +01:00
committed by GitHub
parent a989ccdc1a
commit ae003913a3
+10 -4
View File
@@ -385,11 +385,17 @@ These are the available config options for making requests. Only the `url` is re
ID: 12345 ID: 12345
}, },
// `paramsSerializer` is an optional config in charge of serializing `params` // `paramsSerializer` is an optional config that allows you to customize serializing `params`.
paramsSerializer: { paramsSerializer: {
encode?: (param: string): string => { /* Do custom ops here and return transformed string */ }, // custom encoder function; sends Key/Values in an iterative fashion
serialize?: (params: Record<string, any>, options?: ParamsSerializerOptions ), // mimic pre 1.x behavior and send entire params object to a custom serializer func. Allows consumer to control how params are serialized. //Custom encoder function which sends key/value pairs in an iterative fashion.
indexes: false // array indexes format (null - no brackets, false (default) - empty brackets, true - brackets with indexes) encode?: (param: string): string => { /* Do custom operations here and return transformed string */ },
// Custom serializer function for the entire parameter. Allows user to mimic pre 1.x behaviour.
serialize?: (params: Record<string, any>, options?: ParamsSerializerOptions ),
//Configuration for formatting array indexes in the params.
indexes: false // Three available options: (1) indexes: null (leads to no brackets), (2) (default) indexes: false (leads to empty brackets), (3) indexes: true (leads to brackets with indexes).
}, },
// `data` is the data to be sent as the request body // `data` is the data to be sent as the request body