Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

paramsSerializer documentation is outdated #5632

Open
mauriciosoares opened this issue Apr 5, 2023 · 4 comments
Open

paramsSerializer documentation is outdated #5632

mauriciosoares opened this issue Apr 5, 2023 · 4 comments
Labels
priority::high A high priority issue

Comments

@mauriciosoares
Copy link

Section/Content To Improve

In the https://axios-http.com/docs/req_config docs, the paramsSerializer usage says that it accepts a function in charge of serializing params,

image

however on the newest version of axios (I'm using 1.3.4) this will produce a TS error

image

That's because now paramsSerializer uses an object that accepts a encode and serialize configuration

Suggested Improvement

Update that portion of the paramsSerializer documentation for the new approach with {serialize,encode}

Relevant File(s)

No response
@Khareayushh
Copy link

Giving you a text file can someone check will this change in documentation is valid, If yes then I will create a PR.
paramsSerializer.txt

@sagardesai1 sagardesai1 mentioned this issue Jan 22, 2024
Open
@sagardesai1
Copy link

sagardesai1 commented Jan 22, 2024 •
edited
Loading

Hi, I've created a PR to resolve this in all of the languages.
axios/axios-docs#177

@sagardesai1
Copy link

@jasonsaayman would you mind reviewing and approving the pr?

@DigitalBrainJS
Copy link
Collaborator

Since v1.3.5 (#5633) paramsSerializer accepts both types (object & function).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
priority::high A high priority issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@mauriciosoares @jasonsaayman @DigitalBrainJS @sagardesai1 @Khareayushh @DavidJDallas