Skip to content

docs(readme): clarify withCredentials and withXSRFToken behavior#7452

Merged
jasonsaayman merged 2 commits intoaxios:v1.xfrom
theamodhshetty:codex/docs-with-xsrf-token
Apr 5, 2026
Merged

docs(readme): clarify withCredentials and withXSRFToken behavior#7452
jasonsaayman merged 2 commits intoaxios:v1.xfrom
theamodhshetty:codex/docs-with-xsrf-token

Conversation

@theamodhshetty
Copy link
Copy Markdown
Contributor

@theamodhshetty theamodhshetty commented Feb 27, 2026

Summary

This updates the Request Config docs to clarify how withXSRFToken works.

  • Clarifies that withCredentials controls browser credential mode only.
  • Clarifies that withCredentials does not toggle XSRF header injection.
  • Documents the withXSRFToken modes: undefined (default), true, false, and function resolver.

Why

Issue #7450 reported missing/unclear docs around withXSRFToken and its relation to withCredentials. This makes that behavior explicit in the main config reference.

Closes #7450

Testing

  • npm run test:eslint

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

@jasonsaayman jasonsaayman added priority::low A low priority issue commit::docs The PR is related to docs labels Apr 5, 2026
@jasonsaayman jasonsaayman merged commit 923ae8f into axios:v1.x Apr 5, 2026
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

commit::docs The PR is related to docs priority::low A low priority issue

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Missing withXSRFToken option in Request Config documentation

2 participants