v5.5.5

Compare Source

v5.1.1

Compare Source

What's Changed

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

New Contributors

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

New Contributors

• @​orgads made their first contribution in https://github.com/redis/node-redis/pull/2945
• @​garyburgmann made their first contribution in https://github.com/redis/node-redis/pull/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 https://github.com/redis/node-redis/pull/2896
• Update CHANGELOG.md, fix typo(s) by @​NicholasWilsonDEV in https://github.com/redis/node-redis/pull/2861
• fix: update package-lock.json by @​nkaradzhov in https://github.com/redis/node-redis/pull/2939
• chore(examples): fix examples for v5 by @​nkaradzhov in https://github.com/redis/node-redis/pull/2938
• Update packages/redis/README.md by @​nkaradzhov in https://github.com/redis/node-redis/pull/2935

New Contributors

• @​rickyssj2 made their first contribution in https://github.com/redis/node-redis/pull/2896
• @​NicholasWilsonDEV made their first contribution in https://github.com/redis/node-redis/pull/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 https://github.com/redis/node-redis/pull/2901
• Added HGETEX, HSETEX, HGETDEL hash field expiration commands by @​htemelski in https://github.com/redis/node-redis/pull/2907
• feat(auth): add Entra ID identity provider integration for Redis client authentication by @​bobymicroby in https://github.com/redis/node-redis/pull/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 https://github.com/redis/node-redis/pull/2930
• ft.create now accepts a union type for the TYPE field which includes the newly supported integer8 and uinteger8 types by @​htemelski in https://github.com/redis/node-redis/pull/2911
• new "transform arguments" API for better key and metadata extraction by @​sjpotter in https://github.com/redis/node-redis/pull/2733
• fix sentinel generics by @​sjpotter in https://github.com/redis/node-redis/pull/2859
• Fix creation of cluster client again by @​soccermax in https://github.com/redis/node-redis/pull/2870
• Fix cluster-slots discover race condition again by @​jjsimps in https://github.com/redis/node-redis/pull/2867
• Update tests.yml by @​ozennou in https://github.com/redis/node-redis/pull/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 https://github.com/redis/node-redis/pull/2897
• 'FT.PROFILE' now returns untyped (as-is) response by @​bobymicroby in https://github.com/redis/node-redis/pull/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 https://github.com/redis/node-redis/pull/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 https://github.com/redis/node-redis/pull/2887
• @​bobymicroby made their first contribution in https://github.com/redis/node-redis/pull/2877
• @​htemelski made their first contribution in https://github.com/redis/node-redis/pull/2895
• @​spavlov6 made their first contribution in https://github.com/redis/node-redis/pull/2915
• @​dhensby made their first contribution in https://github.com/redis/node-redis/pull/2920
• @​nkaradzhov made their first contribution in https://github.com/redis/node-redis/pull/2929