Update documentation to clarify side effects of setupCache #732
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.
Key Changes:
Update documentation to clarify that using
setupCache
on the default axios import or onwindow.axios
will apply the cache interceptor everywhere that default export instance is used.Reason for change:
Adds necessary clarification so that the end user has full knowledge of the consequences of invoking setupCache on the default export. For those who are not very familiar with JS or axios, such a clarification could help them avoid unwanted caching of data.
Such unwanted caching can be even more problematic when resources are not uniquely identified by their URL and instead distinguished through headers (it's a bad practice but it is a practice nonetheless), which can lead even to sharing of data between users for instance.
This is by no means a fault of this library but one of the end user, but still, if we can help the user avoid such a situation, why not? 😃