Skip to content

Commit

Permalink
headers behavior notes
Browse files Browse the repository at this point in the history
  • Loading branch information
nfriedly committed Feb 13, 2020
1 parent ed501ae commit 3f71ac4
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,13 +139,13 @@ Defaults to `429`.

Enable headers for request limit (`X-RateLimit-Limit`) and current usage (`X-RateLimit-Remaining`) on all responses and time to wait before retrying (`Retry-After`) when `max` is exceeded.

Defaults to `true`.
Defaults to `true`. Behavior may change in the next major release.

### draft_polli_ratelimit_headers

Enable headers conforming to the [ratelimit standardization proposal](https://tools.ietf.org/id/draft-polli-ratelimit-headers-01.html): `RateLimit-Limit`, `RateLimit-Remaining`, and, if the store supports it, `RateLimit-Reset`. May be used in conjunction with, or instead of the `headers` option.

Defaults to `false`, but will likely be changed in the next major release.
Defaults to `false`. Behavior and name will likely change in future releases.

### keyGenerator

Expand Down

0 comments on commit 3f71ac4

Please sign in to comment.