Skip to content

docs(readme): document Retry-After 429 header (#324) #325

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

Merged
CryptoJones merged 1 commit into from
May 19, 2026
Merged

docs(readme): document Retry-After 429 header (#324) #325

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,11 @@ Working example at [node.timetrackerapi.com](http://node.timetrackerapi.com).
propagate trace context from a reverse proxy / mesh.
- **`RateLimit-*` (response headers, RFC standard)** — `RateLimit-Limit`,
`RateLimit-Remaining`, `RateLimit-Reset` on every /v1/* response.
- **`Retry-After` (response header on 429, RFC 7231)** — seconds the
client should wait before retrying when the quota is exhausted.
Cross-origin browser JS can read this via the CORS expose-headers
list (it's not on the CORS safelist) so SDKs can honor the server's
back-off instead of falling back to a fixed-delay retry.
- Browser JS reading any of the above on a cross-origin response works
out-of-the-box: the CORS layer's `Access-Control-Expose-Headers` covers them.

Expand Down