Update dependency redis to v5

[renovate]

This PR contains the following updates:

Package	Change	Age	Confidence
redis	^3.1.1 → ^5.0.0
redis	^4.7.1 → ^5.0.0

---

Warning

Some dependencies could not be looked up. Check the Dependency Dashboard for more information.

---

Release Notes

redis/node-redis (redis)

v5.10.0

Compare Source

Changes

🚀 New Features

• Add MSETEX command support (#​3116)
• Add CLAIM attribute to XREADGROUP command (#​3122)
• Add index/query doc page examples (#​3109)

🧪 Experimental Features

• Add support for CAS/CAD, DELEX, DIGEST commands (#​3123)
• Add support for HYBRID search (#​3119 #​3132)
• Add latency histogram (#​3099)

🐛 Bug Fixes

• Fix dist/package.json version bumping in release process (#​3125)
• Prevent false-ready state when socket errors during handshake (#​3128)
• Don't parse number properties in XREADGROUP (#​3133)

🧰 Maintenance

• Apply proxy improvements (#​3121)
• Mark 8.4 features as experimental (#​3134)
• Extract supported Redis versions into SUPPORTED_REDIS_VERSIONS.md (#​3131)
• Bump test container image to 8.4.0 (#​3139)

---

Contributors

We'd like to thank all the contributors who worked on this release!

• @​andy-stark-redis
• @​htemelski-redis
• @​nkaradzhov
• @​NaughtySora
• @​PavelPashov

Full Changelog: https://github.com/redis/node-redis/compare/[email protected]@5.10.0

v5.9.0

Compare Source

What's Changed

• fix(ts): use all commands in cluster type by @​nkaradzhov in #​3065
• Main by @​watersRand in #​3047
• docs: fix scanIterator example in readme by @​nkaradzhov in #​3072
• Hitless upgrades by @​nkaradzhov in #​3021
• fix(cluster): prevent infinite loop by @​nkaradzhov in #​3078
• docs: update RedisJSON documentation link by @​Caiuriuller in #​3079
• refactor(test): improve test scenario reliability and maintainability by @​PavelPashov in #​3077
• Improve stale issue management workflow by @​elena-kolevska in #​3082
• Maint fixes by @​nkaradzhov in #​3086
• feat: add default modules to createClientPool by @​killagu in #​3088
• DOC-5743 BITOP examples by @​andy-stark-redis in #​3087
• feat: add typed/untyped mode support for multi-commands by @​PavelPashov in #​3084
• Fix: resolve doubly linked list push issue by @​ntvviktor in #​3085
• Update default Redis version to 8.4-M01-pre in tests by @​bobymicroby in #​3092
• Adjust scenario tests according to latest maint naming changes by @​nkaradzhov in #​3090
• test(maint): touch up wrong assertions by @​nkaradzhov in #​3096
• fix(pool): make createClientPool use provided options by @​nkaradzhov in #​3095
• Emit invalidate events from client by @​sastcsgh in #​3076
• Fix client kill enums by @​watersRand in #​3074
• cluster/node events (#​1855) by @​NaughtySora in #​3083
• fix(ssubscribe): properly resubscribe in case of shard failover by @​nkaradzhov in #​3098
• fix: multi-byte character corruption when converting Buffers to strings by @​brb3 in #​3100
• fix(cmd): PUBSUB_NUMSUB return count as number by @​nkaradzhov in #​3103
• Extend proxy by @​nkaradzhov in #​3105

New Contributors

• @​watersRand made their first contribution in #​3047
• @​Caiuriuller made their first contribution in #​3079
• @​elena-kolevska made their first contribution in #​3082
• @​killagu made their first contribution in #​3088
• @​ntvviktor made their first contribution in #​3085
• @​sastcsgh made their first contribution in #​3076
• @​NaughtySora made their first contribution in #​3083
• @​brb3 made their first contribution in #​3100

Full Changelog: https://github.com/redis/node-redis/compare/[email protected]@5.9.0

v5.8.3

Compare Source

What's Changed

• fix: add typed/untyped mode support for multi-commands by @​PavelPashov in #​3084

Full Changelog: https://github.com/redis/node-redis/compare/[email protected]@5.8.3

v5.8.2

Compare Source

What's Changed

• Clustering sendCommand docs by @​nfriedly in #​3053
• Stop erasing ErrorReply stack by @​dxg in #​3050
• Call out sendCommand cluster difference in readme by @​nfriedly in #​3054
• fix(ts): xtrim threshold accepts string by @​Eomm in #​3058
• chore(tests): bump test container version 8.2.1-pre by @​nkaradzhov in #​3057
• fix(sentinel): properly pass reconnectStrategy by @​nkaradzhov in #​3063
• fix(search): properly decide if response has docs by @​nkaradzhov in #​3060

New Contributors

• @​nfriedly made their first contribution in #​3053
• @​dxg made their first contribution in #​3050

Full Changelog: https://github.com/redis/node-redis/compare/[email protected]@5.8.2

v5.8.1

Compare Source

What's Changed

• chore(tests): bump test container version 8.2 by @​nkaradzhov in #​3046
• fix(commands): expire, expireAt are not readonly by @​nkaradzhov in #​3045
• fix: parse database from Redis URL by @​PavelPashov in #​3052

Full Changelog: https://github.com/redis/node-redis/compare/[email protected]@5.8.1

v5.8.0

Compare Source

v5.7.0

Compare Source

What's Changed

• fix(pool): chain promise handlers to prevent unhandled rejections by @​PavelPashov in #​3035
• Add Redis 8.2 New Stream Commands by @​PavelPashov in #​3029
• DOC-5473 added time series doc examples by @​andy-stark-redis in #​3030
• DOC-5074 added vector set doc examples by @​andy-stark-redis in #​3031
• fix(scan): remove console.logs by @​nkaradzhov in #​3038
• feat: add EPSILON parameter support to VSIM command by @​PavelPashov in #​3041

New Contributors

• @​andy-stark-redis made their first contribution in #​3030

Full Changelog: https://github.com/redis/node-redis/compare/[email protected]@5.7.0

v5.6.1

Compare Source

What's Changed

• docs: fix hyperlink for lua scripts, functions by @​cloneot in #​3015
• fix(search): adjust field types for ft.search by @​nkaradzhov in #​3018
• fix(client): make socket.host not required by @​nkaradzhov in #​3024
• fix(client): export RedisJSON type by @​nkaradzhov in #​3026
• Update doctests by @​PavelPashov in #​3020
• Add Redis transparent proxy test utilities by @​bobymicroby in #​3019

New Contributors

• @​cloneot made their first contribution in #​3015

Full Changelog: https://github.com/redis/node-redis/compare/[email protected]@5.6.1

v5.6.0

Compare Source

What's Changed

• fix(client): make unstable cmds throw by @​nkaradzhov in #​2990
• chore(tests): bump test container version 8.0.2 by @​nkaradzhov in #​2997
• chore(actions): add action to close stale issues by @​nkaradzhov in #​3000
• Add Support For New Bitop Operations by @​PavelPashov in #​3001
  • The new operations are supported since redis 8.2-M01
• Vector sets by @​nkaradzhov in #​2998
• fix(commands): sPopCount return Array by @​nkaradzhov in #​3006
• fix: ensure the repo links in the README are functional on the website by @​thegiantbeast in #​3005
• fix(sentinel): propagate RESP option to clients by @​nkaradzhov in #​3011
• Add command timeout by @​nkaradzhov and @​florian-schunk in #​3008
• chore(release): use deploy keys for release by @​nkaradzhov in #​3013

New Contributors

• @​PavelPashov made their first contribution in #​3001
• @​thegiantbeast made their first contribution in #​3005
• @​florian-schunk made their first contribution in #​3008

Full Changelog: https://github.com/redis/node-redis/compare/[email protected]@5.6.0

v5.5.6

Compare Source

Note: During our efforts to automate the release process, we inadvertently bumped the version from 5.1.1 to 5.5.5, skipping a few minor versions. No features or changes were actually released in those skipped versions — 5.5.6 is the first release since 5.1.1 with actual changes. We’re now back on track, and the automation is in place moving forward.

What's Changed

• add jsdoc comments to command parsers by @​bobymicroby in #​2984
• Automate release by @​nkaradzhov in #​2977
• fix(search): align ft.search with server by @​nkaradzhov in #​2988
• docs: update SchemaFieldTypes to SCHEMA_FIELD_TYPE for [email protected] by @​23navi in #​2992

New Contributors

• @​23navi made their first contribution in #​2992

Full Changelog: https://github.com/redis/node-redis/compare/[email protected]@5.5.6

v5.5.5

Compare Source

v5.1.1

Compare Source

What's Changed

• fix(handshake): ignore errors on client.setinfo by @​nkaradzhov in #​2969
• fix(cluster): replace native private with _ by @​nkaradzhov in #​2971
• fix(json): remove debug console.logs by @​nkaradzhov in #​2970
• Adapt legacy sentinel tests to use the new test utils by @​htemelski in #​2976
• docs(readme): replace relative GitHub links with absolute URLs by @​aryamohanan in #​2980

New Contributors

• @​aryamohanan made their first contribution in #​2980

Full Changelog: https://github.com/redis/node-redis/compare/[email protected]@5.1.1

v5.1.0

Compare Source

What's Changed

• fix(client): add type annotations by @​nkaradzhov in #​2949
• Export CommandParser from client index file and fix doc by @​orgads in #​2945
• fix: fix various command import issues by @​nkaradzhov in #​2944
• update package-lock.json by @​nkaradzhov in #​2943
• fix cluster.sUnsubscribe - make listener optional by @​Clsan in #​2946
• Disable readOnly for cluster s/pubsub client by @​htemelski in #​2950
• Update Redis version to 8.0.1-pre by @​bobymicroby in #​2952
• revert the 'total' count logic in AGGREGATE response introduced in #​2952 by @​bobymicroby in #​2955
• fix(client): cache subsequent clients by @​nkaradzhov in #​2963
• Client Side Caching by @​bobymicroby in #​2947
• Fix sentinel csc tests by @​htemelski in #​2966
• Introduce socketTimeout option by @​nkaradzhov in #​2965
• fix(client): bring disableClientInfo option back by @​nkaradzhov in #​2959
• issue/2956 - document disableClientInfo by @​garyburgmann in #​2957

New Contributors

• @​orgads made their first contribution in #​2945
• @​garyburgmann made their first contribution in #​2957

Full Changelog: https://github.com/redis/node-redis/compare/[email protected]@5.1.0

v5.0.1

Compare Source

What's Changed

• doc: clarify connection pooling in createClient and fix broken link in isolationPoolOptions by @​rickyssj2 in #​2896
• Update CHANGELOG.md, fix typo(s) by @​NicholasWilsonDEV in #​2861
• fix: update package-lock.json by @​nkaradzhov in #​2939
• chore(examples): fix examples for v5 by @​nkaradzhov in #​2938
• Update packages/redis/README.md by @​nkaradzhov in #​2935

New Contributors

• @​rickyssj2 made their first contribution in #​2896
• @​NicholasWilsonDEV made their first contribution in #​2861

Full Changelog: https://github.com/redis/node-redis/compare/[email protected]@5.0.1

v5.0.0

Compare Source

Redis Node.js Client Release Notes

🚀 New Features

• EntraID added support for azure identity by @​bobymicroby in #​2901
• Added HGETEX, HSETEX, HGETDEL hash field expiration commands by @​htemelski in #​2907
• feat(auth): add Entra ID identity provider integration for Redis client authentication by @​bobymicroby in #​2877
• RESP3 support : Node Redis v5 adds support for RESP3, the new Redis serialization protocol introduced in Redis 6.0. RESP3 offers richer data types and improved type handling compared to RESP2
• Sentinel: Redis Sentinel provides high availability for Redis through monitoring, automatic failover, and client-side support.
• Type mapping: Version five allows you configuring the type mapping. Responses can be mapped to objects, arrays, or maps. Likewise, numeric formats can be mapped to either strings or numbers.

🛠️ Improvements

• Infer the cluster pubsub client read only mode from the node type by @​htemelski in #​2930
• ft.create now accepts a union type for the TYPE field which includes the newly supported integer8 and uinteger8 types by @​htemelski in #​2911
• new "transform arguments" API for better key and metadata extraction by @​sjpotter in #​2733
• fix sentinel generics by @​sjpotter in #​2859
• Fix creation of cluster client again by @​soccermax in #​2870
• Fix cluster-slots discover race condition again by @​jjsimps in #​2867
• Update tests.yml by @​ozennou in #​2887
• Typing: Multi-commands are now correctly typed.
• API changes: Several API changes are documented in https://github.com/redis/node-redis/blob/master/docs/v4-to-v5.md

BREAKING CHANGES

• Removed graph module by @​bobymicroby in #​2897
• 'FT.PROFILE' now returns untyped (as-is) response by @​bobymicroby in #​2893
• Introduced a client-side default dialect for Redis' search and query capabilities. By default, the client now overrides the server-side dialect with version 2, automatically appending DIALECT 2 to commands like FT.AGGREGATE and FT.SEARCH.
  Important: Be aware that the query dialect may impact the results returned. If needed, you can revert to a different dialect version by passing an option to the search commands. You can find further details in the query dialect documentation. by @​htemelski in #​2895

client.ft.search('index', '*', {DIALECT: 1})

• Client Configuration:

  • keepAlive option has been split into keepAlive (boolean) and keepAliveInitialDelay (number)
  • Legacy mode is now accessed via .legacy() method instead of { legacyMode: true }

• Command Options:

  • New API uses "proxy client" to store options instead of passing them directly to commands
  • Example: client.withCommandOptions({ ... }).get('key') instead of client.get(client.commandOptions({ ... }), 'key')

• Connection Management:

  • client.QUIT/quit() is replaced by client.close()
  • client.disconnect() has been renamed to client.destroy()

• Scan Iterators:

  • Now yield collections of items instead of individual items
  • Example: for await (const keys of client.scanIterator()) { ... } returns arrays of keys

• Isolation Pool:

  • Superseded by RedisClientPool for better separation of concerns

• Cluster Multi:

  • cluster.multi().addCommand() now requires isReadonly parameter for replica execution support

• Boolean to Number Types:

  • Many commands now return numbers (0/1) instead of booleans for better Redis protocol alignment
  • Affects: COPY, EXPIRE, EXPIREAT, HEXISTS, HSETNX, MOVE, PEXPIRE, PEXPIREAT, PFADD, RENAMENX, SETNX, etc.

• API Changes:

  • Many commands have updated parameter names and return types
  • Enums replaced with constants (e.g., RedisFlushModes → REDIS_FLUSH_MODES)
  • Module-specific commands (JSON, Search, Time Series) have parameter restructuring

Full migration details: https://github.com/redis/node-redis/blob/master/docs/v4-to-v5.md

New Contributors

• @​ozennou made their first contribution in #​2887
• @​bobymicroby made their first contribution in #​2877
• @​htemelski made their first contribution in #​2895
• @​spavlov6 made their first contribution in #​2915
• @​dhensby made their first contribution in #​2920
• @​nkaradzhov made their first contribution in #​2929

v4.7.1

Compare Source

v4.7.0

Compare Source

Enhancements

• Upgrade @redis/client from 1.5.16 to 1.6.0
• Upgrade @redis/json from 1.0.6 to 1.0.7
• Upgrade @redis/search from 1.1.6 to 1.2.0
• Upgrade @redis/time-series from 1.0.5 to 1.1.0

v4.6.15

Compare Source

Enhancements

• Upgrade @redis/client from 1.5.16 to 1.5.17

v4.6.14

Compare Source

Enhancements

• Upgrade @redis/client from 1.5.14 to 1.5.16

v4.6.13

Compare Source

Enhancements

• Upgrade @redis/client from 1.5.13 to 1.5.14

v4.6.12

Compare Source

Enhancements

• Upgrade @redis/client from 1.5.12 to 1.5.13

v4.6.11

Compare Source

Enhancements

• Upgrade @redis/client from 1.5.11 to 1.5.12
• Upgrade @redis/graph from 1.1.0 to 1.1.1
• Upgrade @redis/json from 1.1.5 to 1.1.6

v4.6.10

Compare Source

Fixes

• Revert the minimum node version change
• Upgrade @redis/client from 1.5.9 to 1.5.10
• Upgrade @redis/search from 1.1.3 to 1.1.4
• Upgrade @redis/json from 1.0.4 to 1.0.5

v4.6.9

Compare Source

Enhancements

• Upgrade @redis/client from 1.5.9 to 1.5.10
• Upgrade @redis/search from 1.1.3 to 1.1.4
• Upgrade @redis/json from 1.0.4 to 1.0.5

v4.6.8

Compare Source

Enhancements

• upgrade @redis/client from 1.5.8 to 1.5.9
• upgrade @redis/time-series from 1.0.4 to 1.0.5

v4.6.7

Compare Source

Enhancements

• upgrade @redis/client from 1.5.7 to 1.5.8
• upgrade @redis/search from 1.1.2 to 1.1.3

v4.6.6

Compare Source

Enhancements

• upgrade @redis/client from 1.5.6 to 1.5.7

v4.6.5

Compare Source

Enhancements

• upgrade @redis/client from 1.5.5 to 1.5.6

v4.6.4

Compare Source

Enhancements

• upgrade @redis/client from 1.5.4 to 1.5.5

v4.6.3

Compare Source

Enhancements

• upgrade @redis/client from 1.5.3 to 1.5.4

v4.6.2

Compare Source

Enhancements

• upgrade @redis/client from 1.5.2 to 1.5.3

v4.6.1

Compare Source

Enhancements

• upgrade @redis/client from 1.5.0 to 1.5.2

v4.6.0

Compare Source

Enhancements

• upgrade @redis/client from 1.4.2 to 1.5.0
• upgrade @redis/bloom from 1.1.0 to 1.2.0
• upgrade @redis/search from 1.1.0 to 1.1.1

v4.5.1

Compare Source

Enhancements

• upgrade @redis/client

v4.5.0

Compare Source

Enhancements

• upgrade @redis/client
• upgrade @redis/time-series

v4.4.0

Compare Source

Enhancements

• #​2285-Add-example-scripts-hyperloglog - Added hyperloglog examples to… by @​ade1705 in #​2289
• #​2287 Add example scripts showing pub/sub usage. by @​con-mark in #​2288
• Connecting to cluster example by @​varadkarpe in #​2298
• Adds transaction with watched key example script. by @​sailingwithsandeep in #​2297
• Fixes typo Redis Search -> RediSearch by @​simonprickett in #​2278
• Fixed redis -> Redis in a couple places. by @​simonprickett in #​2279
• Update search-json.js by @​leibale in #​2317
• test with node 19 instead of 17 by @​leibale in #​2316
• disconnect in basic example by @​reviewher in #​2235
• upgrade @redis/client
• upgrade @redis/bloom
• upgrade @redis/graph

v4.3.1

Compare Source

Enhancements

• Upgrade @redis/json

v4.3.0

Compare Source

Enhancements

• Upgrade @redis/client
• Upgrade @redis/search

v4.2.0

Compare Source

Enhancements

• Upgrade @redis/client

v4.1.1

Compare Source

Enhancements

• Upgrade @redis/client

v4.1.0

Compare Source

Enhancements

• Upgrade @redis/bloom
• Upgrade @redis/client
• Upgrade @redis/graph
• Upgrade @redis/json
• Upgrade @redis/search
• Upgrade @redis/time-series

v4.0.6

Compare Source

• Upgrade @node-redis/client
• Upgrade @node-redis/search

v4.0.5

Compare Source

v4.0.4

Compare Source

• Upgrade @node-redis/client
• Upgrade @node-redis/search
• Upgrade @node-redis/time-series

v4.0.3

Compare Source

• First release with @node-redis/graph
• Upgrade to @node-redis/[email protected]

v4.0.2

Compare Source

Fixes

• Fix v4 commands in legacy mode (#​1820)
• Fix EXISTS command reply (#​1819)
• Fix handler for "redis:invalidate" messages (#​1798)
• Fix "SEPARATOR" typo in RediSearch (#​1823)

Enhancements

• First release of @node-redis/bloom
• Add support for Buffers
• Enhance ASK and MOVED errors handler

v4.0.1

Compare Source

Fixes

• Fix NOAUTH error when using authentication & database (#​1681)
• Allow to .quit() in PubSub mode (#​1766)
• Add an option to configure name on a client (#​1758)
• Lowercase commands (client.hset) in legacyMode
• Fix PubSub resubscribe (#​1764)
• Fix RedisSocketOptions type (#​1741)

Enhancements

• Add support for numbers and Buffers in HSET (#​1738 #​1739)
• Export RedisClientType, RedisClusterType and some more types (#​1673)
• First release of @node-redis/time-series

v4.0.0

Compare Source

This version is a major change and refactor, adding modern JavaScript capabilities and multiple breaking changes. See the migration guide for tips on how to upgrade.

Breaking Changes

• All functions return Promises by default
• Dropped support for Node.js 10.x, the minimum supported Node.js version is now 12.x
• createClient takes new and different arguments
• The prefix, rename_commands configuration options to createClient have been removed
• The enable_offline_queue configuration option is removed, executing commands on a closed client (without calling .connect() or after calling .disconnect()) will reject immediately
• Login credentials are no longer saved when using .auth() directly

Features

• Added support for Promises
• Added built-in TypeScript declaration files enabling code completion
• Added support for clustering
• Added idiomatic arguments and responses to Redis commands
• Added full support for Lua Scripts
• Added support for SCAN iterators
• Added the ability to extend Node Redis with Redis Module commands

---

Configuration

📅 Schedule: Branch creation - "after 7am and before 11am every weekday" in timezone Europe/London, Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about these updates again.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.