redis 5.1.0 → 5.5.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -19
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/package.json +9 -6
package/README.md
CHANGED
|
@@ -45,13 +45,13 @@ npm install redis
|
|
|
45
45
|
|
|
46
46
|
| Name | Description |
|
|
47
47
|
| ---------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
|
48
|
-
| [`redis`](
|
|
49
|
-
| [`@redis/client`](
|
|
50
|
-
| [`@redis/bloom`](
|
|
51
|
-
| [`@redis/json`](
|
|
52
|
-
| [`@redis/search`](
|
|
53
|
-
| [`@redis/time-series`](
|
|
54
|
-
| [`@redis/entraid`](
|
|
48
|
+
| [`redis`](https://github.com/redis/node-redis/tree/master/packages/redis) | The client with all the ["redis-stack"](https://github.com/redis-stack/redis-stack) modules |
|
|
49
|
+
| [`@redis/client`](https://github.com/redis/node-redis/tree/master/packages/client) | The base clients (i.e `RedisClient`, `RedisCluster`, etc.) |
|
|
50
|
+
| [`@redis/bloom`](https://github.com/redis/node-redis/tree/master/packages/bloom) | [Redis Bloom](https://redis.io/docs/data-types/probabilistic/) commands |
|
|
51
|
+
| [`@redis/json`](https://github.com/redis/node-redis/tree/master/packages/json) | [Redis JSON](https://redis.io/docs/data-types/json/) commands |
|
|
52
|
+
| [`@redis/search`](https://github.com/redis/node-redis/tree/master/packages/search) | [RediSearch](https://redis.io/docs/interact/search-and-query/) commands |
|
|
53
|
+
| [`@redis/time-series`](https://github.com/redis/node-redis/tree/master/packages/time-series) | [Redis Time-Series](https://redis.io/docs/data-types/timeseries/) commands |
|
|
54
|
+
| [`@redis/entraid`](https://github.com/redis/node-redis/tree/master/packages/entraid) | Secure token-based authentication for Redis clients using Microsoft Entra ID |
|
|
55
55
|
|
|
56
56
|
> Looking for a high-level library to handle object mapping?
|
|
57
57
|
> See [redis-om-node](https://github.com/redis/redis-om-node)!
|
|
@@ -83,7 +83,7 @@ createClient({
|
|
|
83
83
|
```
|
|
84
84
|
|
|
85
85
|
You can also use discrete parameters, UNIX sockets, and even TLS to connect. Details can be found in
|
|
86
|
-
the [client configuration guide](
|
|
86
|
+
the [client configuration guide](https://github.com/redis/node-redis/blob/master/docs/client-configuration.md).
|
|
87
87
|
|
|
88
88
|
To check if the the client is connected and ready to send commands, use `client.isReady` which returns a boolean.
|
|
89
89
|
`client.isOpen` is also available. This returns `true` when the client's underlying socket is open, and `false` when it
|
|
@@ -188,7 +188,7 @@ await pool.ping();
|
|
|
188
188
|
|
|
189
189
|
### Pub/Sub
|
|
190
190
|
|
|
191
|
-
See the [Pub/Sub overview](
|
|
191
|
+
See the [Pub/Sub overview](https://github.com/redis/node-redis/blob/master/docs/pub-sub.md).
|
|
192
192
|
|
|
193
193
|
### Scan Iterator
|
|
194
194
|
|
|
@@ -250,7 +250,7 @@ const client = createClient({
|
|
|
250
250
|
});
|
|
251
251
|
```
|
|
252
252
|
|
|
253
|
-
See the [V5 documentation](
|
|
253
|
+
See the [V5 documentation](https://github.com/redis/node-redis/blob/master/docs/v5.md#client-side-caching) for more details and advanced usage.
|
|
254
254
|
|
|
255
255
|
### Auto-Pipelining
|
|
256
256
|
|
|
@@ -274,11 +274,11 @@ await Promise.all([
|
|
|
274
274
|
|
|
275
275
|
### Programmability
|
|
276
276
|
|
|
277
|
-
See the [Programmability overview](
|
|
277
|
+
See the [Programmability overview](https://github.com/redis/node-redis/blob/master/docs/programmability.md).
|
|
278
278
|
|
|
279
279
|
### Clustering
|
|
280
280
|
|
|
281
|
-
Check out the [Clustering Guide](
|
|
281
|
+
Check out the [Clustering Guide](https://github.com/redis/node-redis/blob/master/docs/clustering.md) when using Node Redis to connect to a Redis Cluster.
|
|
282
282
|
|
|
283
283
|
### Events
|
|
284
284
|
|
|
@@ -291,12 +291,12 @@ The Node Redis client class is an Nodejs EventEmitter and it emits an event each
|
|
|
291
291
|
| `end` | Connection has been closed (via `.disconnect()`) | _No arguments_ |
|
|
292
292
|
| `error` | An error has occurred—usually a network issue such as "Socket closed unexpectedly" | `(error: Error)` |
|
|
293
293
|
| `reconnecting` | Client is trying to reconnect to the server | _No arguments_ |
|
|
294
|
-
| `sharded-channel-moved` | See [here](
|
|
294
|
+
| `sharded-channel-moved` | See [here](https://github.com/redis/node-redis/blob/master/docs/pub-sub.md#sharded-channel-moved-event) | See [here](https://github.com/redis/node-redis/blob/master/docs/pub-sub.md#sharded-channel-moved-event) |
|
|
295
295
|
|
|
296
296
|
> :warning: You **MUST** listen to `error` events. If a client doesn't have at least one `error` listener registered and
|
|
297
297
|
> an `error` occurs, that error will be thrown and the Node.js process will exit. See the [ > `EventEmitter` docs](https://nodejs.org/api/events.html#events_error_events) for more details.
|
|
298
298
|
|
|
299
|
-
> The client will not emit [any other events](
|
|
299
|
+
> The client will not emit [any other events](https://github.com/redis/node-redis/blob/master/docs/v3-to-v4.md#all-the-removed-events) beyond those listed above.
|
|
300
300
|
|
|
301
301
|
## Supported Redis versions
|
|
302
302
|
|
|
@@ -313,13 +313,13 @@ Node Redis is supported with the following versions of Redis:
|
|
|
313
313
|
|
|
314
314
|
## Migration
|
|
315
315
|
|
|
316
|
-
- [From V3 to V4](
|
|
317
|
-
- [From V4 to V5](
|
|
318
|
-
- [V5](
|
|
316
|
+
- [From V3 to V4](https://github.com/redis/node-redis/blob/master/docs/v3-to-v4.md)
|
|
317
|
+
- [From V4 to V5](https://github.com/redis/node-redis/blob/master/docs/v4-to-v5.md)
|
|
318
|
+
- [V5](https://github.com/redis/node-redis/blob/master/docs/v5.md)
|
|
319
319
|
|
|
320
320
|
## Contributing
|
|
321
321
|
|
|
322
|
-
If you'd like to contribute, check out the [contributing guide](
|
|
322
|
+
If you'd like to contribute, check out the [contributing guide](https://github.com/redis/node-redis/blob/master/CONTRIBUTING.md).
|
|
323
323
|
|
|
324
324
|
Thank you to all the people who already contributed to Node Redis!
|
|
325
325
|
|
|
@@ -327,4 +327,4 @@ Thank you to all the people who already contributed to Node Redis!
|
|
|
327
327
|
|
|
328
328
|
## License
|
|
329
329
|
|
|
330
|
-
This repository is licensed under the "MIT" license. See [LICENSE](
|
|
330
|
+
This repository is licensed under the "MIT" license. See [LICENSE](https://github.com/redis/node-redis/blob/master/LICENSE).
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
/// <reference types="node" />
|
|
2
|
+
/// <reference types="node" />
|
|
2
3
|
import { RedisModules, RedisFunctions, RedisScripts, RespVersions, TypeMapping, RedisClientOptions, RedisClientType as GenericRedisClientType, RedisClusterOptions, RedisClusterType as genericRedisClusterType, RedisSentinelOptions, RedisSentinelType as genericRedisSentinelType } from '@redis/client';
|
|
3
4
|
export * from '@redis/client';
|
|
4
5
|
export * from '@redis/bloom';
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;AAAA,OAAO,EACL,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,WAAW,EAEX,kBAAkB,EAClB,eAAe,IAAI,sBAAsB,EAEzC,mBAAmB,EACnB,gBAAgB,IAAI,uBAAuB,EAC3C,oBAAoB,EACpB,iBAAiB,IAAI,wBAAwB,EAE9C,MAAM,eAAe,CAAC;AAMvB,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AAEnC,QAAA,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAKZ,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,OAAO,OAAO,CAAC;AAEjD,MAAM,MAAM,eAAe,CACzB,CAAC,SAAS,YAAY,GAAG,mBAAmB,EAC5C,CAAC,SAAS,cAAc,GAAG,EAAE,EAC7B,CAAC,SAAS,YAAY,GAAG,EAAE,EAC3B,IAAI,SAAS,YAAY,GAAG,CAAC,EAC7B,YAAY,SAAS,WAAW,GAAG,EAAE,IACnC,sBAAsB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;AAExD,wBAAgB,YAAY,CAC1B,CAAC,SAAS,YAAY,EACtB,CAAC,SAAS,cAAc,EACxB,CAAC,SAAS,YAAY,EACtB,IAAI,SAAS,YAAY,EACzB,YAAY,SAAS,WAAW,EAEhC,OAAO,CAAC,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,CAAC,GACxD,sBAAsB,CAAC,mBAAmB,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,CAAC,CAQ3E;AAED,MAAM,MAAM,gBAAgB,CAC1B,CAAC,SAAS,YAAY,GAAG,mBAAmB,EAC5C,CAAC,SAAS,cAAc,GAAG,EAAE,EAC7B,CAAC,SAAS,YAAY,GAAG,EAAE,EAC3B,IAAI,SAAS,YAAY,GAAG,CAAC,EAC7B,YAAY,SAAS,WAAW,GAAG,EAAE,IACnC,uBAAuB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;AAEzD,wBAAgB,aAAa,CAC3B,CAAC,SAAS,YAAY,EACtB,CAAC,SAAS,cAAc,EACxB,CAAC,SAAS,YAAY,EACtB,IAAI,SAAS,YAAY,EACzB,YAAY,SAAS,WAAW,EAEhC,OAAO,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,CAAC,GACxD,gBAAgB,CAAC,mBAAmB,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,CAAC,CAQrE;AAED,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,YAAY,GAAG,mBAAmB,EAC5C,CAAC,SAAS,cAAc,GAAG,EAAE,EAC7B,CAAC,SAAS,YAAY,GAAG,EAAE,EAC3B,IAAI,SAAS,YAAY,GAAG,CAAC,EAC7B,YAAY,SAAS,WAAW,GAAG,EAAE,IACnC,wBAAwB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;AAE1D,wBAAgB,cAAc,CAC5B,CAAC,SAAS,YAAY,EACtB,CAAC,SAAS,cAAc,EACxB,CAAC,SAAS,YAAY,EACtB,IAAI,SAAS,YAAY,EACzB,YAAY,SAAS,WAAW,EAEhC,OAAO,EAAE,oBAAoB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,CAAC,GACzD,iBAAiB,CAAC,mBAAmB,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,CAAC,CAQtE"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "redis",
|
|
3
3
|
"description": "A modern, high performance Redis client",
|
|
4
|
-
"version": "5.
|
|
4
|
+
"version": "5.5.5",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"main": "./dist/index.js",
|
|
7
7
|
"types": "./dist/index.d.ts",
|
|
@@ -9,12 +9,15 @@
|
|
|
9
9
|
"dist/",
|
|
10
10
|
"!dist/tsconfig.tsbuildinfo"
|
|
11
11
|
],
|
|
12
|
+
"scripts": {
|
|
13
|
+
"release": "release-it"
|
|
14
|
+
},
|
|
12
15
|
"dependencies": {
|
|
13
|
-
"@redis/bloom": "5.
|
|
14
|
-
"@redis/client": "5.
|
|
15
|
-
"@redis/json": "5.
|
|
16
|
-
"@redis/search": "5.
|
|
17
|
-
"@redis/time-series": "5.
|
|
16
|
+
"@redis/bloom": "5.5.5",
|
|
17
|
+
"@redis/client": "5.5.5",
|
|
18
|
+
"@redis/json": "5.5.5",
|
|
19
|
+
"@redis/search": "5.5.5",
|
|
20
|
+
"@redis/time-series": "5.5.5"
|
|
18
21
|
},
|
|
19
22
|
"engines": {
|
|
20
23
|
"node": ">= 18"
|