-
Notifications
You must be signed in to change notification settings - Fork 153
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.
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
Update Documentation: Clarify paramsSerializer Usage with serialize and encode Fields #195
Open
Gn0lee
wants to merge
19
commits into
axios:master
Choose a base branch
from
Gn0lee:fix/paramsSerializer
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates the axios documentation to clarify the usage of paramsSerializer. The current documentation is insufficient as it does not explain the new method of assigning an object with serialize and encode fields. This update aims to prevent confusion and ensure proper implementation of custom encoding.
Changes Made
Why This Change is Necessary
The recent updates to axios require paramsSerializer to be an object with serialize and encode fields. Without proper documentation, users may face issues where custom encoding cannot be specified, as the function assignment defaults to axios’ basic encoding. This update will help users understand the correct implementation and avoid potential issues.
Related Issue
This documentation update addresses the issue described in [issue #194 ]