docs: add a rate-limiting guide - #441
Merged
mikewheeleer merged 1 commit intoJul 26, 2026
Merged
Conversation
Contributor
|
nice work — shipping it 🚀 |
This file contains hidden or 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.
closes #354
Summary
Add a rate-limiting guide (
docs/rate-limiting.md) covering the sliding-windowalgorithm, bucket keying, eviction policies, config-driven window sizing with
live-patch behaviour, a worked 429 example with
Retry-After, and recommendedclient backoff. Expand
src/__tests__/rateLimit.test.tswith middlewareintegration tests, boundary edge cases, GC interval cycle coverage, and
resolveClientIpunit tests.Related Issue
Closes #354
Validation
npm run buildnpm run lintnpm testChecklist
.envfiles, or private credentials.Security Notes
N/A — docs and test additions only. No changes to runtime authentication,
authorization, input validation, or secret handling.