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.

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
wants to merge 19 commits into
base: master
Choose a base branch
from

Conversation

Gn0lee
Copy link

@Gn0lee Gn0lee commented Jul 21, 2024

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

  • Added a new section in the documentation explaining how to assign paramsSerializer as an object with serialize and encode fields.
  • Provided examples demonstrating the correct usage.
  • Highlighted the difference between the previous method of assigning a function directly and the new object assignment method.

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 ]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant