All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
store.get()
returns 0 instead of NaN
if there are no hits stored for the
client.store.get()
function, to retrieve the hit count and reset time for
a particular client.node
v14 support.express-rate-limit
v7.pkgroll
to bundle library.EVALSHA
command if it fails the first time.types
field to the export
map in package.json
.ioredis
integration.release
action now publishes a GitHub release when a new tag is pushed
with a built .tgz
file so you can install the package from npm and GitHub.sendCommand
option to replace the client
option
sendCommand
is a function that takes the raw command as a string array and
returns the numeric response from redis.esbuild
to build both ES and CommonJS modules and use
dts-bundle-generator
to generate a single type declaration file.express
>= 4 and express-rate-limit
>= 6 as peer dependencies.expiry
option, as we now get that from the rate
limiting middleware in the init
method.client
option, as it is now replaced by the
sendCommand
optionpassIfNotConnected
option, as developers now need to
handle connection using a client of their choicepassIfNotConnected
option.
true
, if the client is not connected to Redis, the store will
allow the request to pass through as a failover.node-redis
version from 2.8.0
to 3.0.2
.resetExpiryOnChange
option.
true
, the store sets the expiry time back to windowMs
when
incrementing/decrementing. This aligns better with how the default handler
in the rate limiting middleware displays the time in the Retry-After
header.decrement
and reset
functions (see
https://github.com/nfriedly/express-rate-limit/commit/c9194780b6826d9cdb14b3395907cf7fb93e59f6)expiry
option.