Skip to content

Commit

Permalink
docs: clarify windowMs description
Browse files Browse the repository at this point in the history 
ref: #454 (comment)
  • Loading branch information
@nfriedly
nfriedly committed Apr 30, 2024
1 parent f0a8c40 commit 86a405d
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions docs/reference/configuration.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,11 @@ icon: 'bars-staggered'

> `number`
Time frame for which requests are checked/remembered. Also used in the
`Retry-After` header when the limit is reached.
Time frame for which requests are checked/remembered. The time window for each
user starts at their first request. After it elapses, the user's hit count is
reset to zero. A new time window is then started on their next request.

Also used in the `Retry-After` header when the limit is reached.

<Note>

Expand Down

1 comment on commit 86a405d

@nfriedly
Copy link
Member Author

Choose a reason for hiding this comment

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

CI failure is due to actions/setup-node#1025

Please sign in to comment.