You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|[`@redis/entraid`](./packages/entraid)| Secure token-based authentication for Redis clients using Microsoft Entra ID |
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.) |
|[`@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](./docs/client-configuration.md).
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](./docs/pub-sub.md).
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
@@ -234,7 +234,6 @@ of sending a `QUIT` command to the server, the client can simply close the netwo
234
234
```typescript
235
235
client.destroy();
236
236
```
237
-
238
237
### Client Side Caching
239
238
240
239
Node Redis v5 adds support for [Client Side Caching](https://redis.io/docs/manual/client-side-caching/), which enables clients to cache query results locally. The Redis server will notify the client when cached results are no longer valid.
@@ -251,7 +250,7 @@ const client = createClient({
251
250
});
252
251
```
253
252
254
-
See the [V5 documentation](./docs/v5.md#client-side-caching) for more details and advanced usage.
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.
255
254
256
255
### Auto-Pipelining
257
256
@@ -275,11 +274,11 @@ await Promise.all([
275
274
276
275
### Programmability
277
276
278
-
See the [Programmability overview](./docs/programmability.md).
277
+
See the [Programmability overview](https://github.com/redis/node-redis/blob/master/docs/programmability.md).
279
278
280
279
### Clustering
281
280
282
-
Check out the [Clustering Guide](./docs/clustering.md) when using Node Redis to connect to a Redis Cluster.
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.
283
282
284
283
### Events
285
284
@@ -292,12 +291,12 @@ The Node Redis client class is an Nodejs EventEmitter and it emits an event each
292
291
|`end`| Connection has been closed (via `.disconnect()`) |_No arguments_|
293
292
|`error`| An error has occurred—usually a network issue such as "Socket closed unexpectedly" |`(error: Error)`|
294
293
|`reconnecting`| Client is trying to reconnect to the server |_No arguments_|
295
-
|`sharded-channel-moved`| See [here](./docs/pub-sub.md#sharded-channel-moved-event)| See [here](./docs/pub-sub.md#sharded-channel-moved-event)|
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)|
296
295
297
296
> :warning: You **MUST** listen to `error` events. If a client doesn't have at least one `error` listener registered and
298
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.
299
298
300
-
> The client will not emit [any other events](./docs/v3-to-v4.md#all-the-removed-events) beyond those listed above.
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.
301
300
302
301
## Supported Redis versions
303
302
@@ -314,18 +313,18 @@ Node Redis is supported with the following versions of Redis:
314
313
315
314
## Migration
316
315
317
-
-[From V3 to V4](docs/v3-to-v4.md)
318
-
-[From V4 to V5](docs/v4-to-v5.md)
319
-
-[V5](docs/v5.md)
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)
0 commit comments