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`](../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](../../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](../../docs/pub-sub.md).
192
192
193
193
### Scan Iterator
194
194
@@ -257,11 +257,11 @@ await Promise.all([
257
257
258
258
### Programmability
259
259
260
-
See the [Programmability overview](./docs/programmability.md).
260
+
See the [Programmability overview](../../docs/programmability.md).
261
261
262
262
### Clustering
263
263
264
-
Check out the [Clustering Guide](./docs/clustering.md) when using Node Redis to connect to a Redis Cluster.
264
+
Check out the [Clustering Guide](../../docs/clustering.md) when using Node Redis to connect to a Redis Cluster.
265
265
266
266
### Events
267
267
@@ -274,12 +274,12 @@ The Node Redis client class is an Nodejs EventEmitter and it emits an event each
274
274
|`end`| Connection has been closed (via `.disconnect()`) |_No arguments_|
275
275
|`error`| An error has occurred—usually a network issue such as "Socket closed unexpectedly" |`(error: Error)`|
276
276
|`reconnecting`| Client is trying to reconnect to the server |_No arguments_|
277
-
|`sharded-channel-moved`| See [here](./docs/pub-sub.md#sharded-channel-moved-event)| See [here](./docs/pub-sub.md#sharded-channel-moved-event)|
277
+
|`sharded-channel-moved`| See [here](../../docs/pub-sub.md#sharded-channel-moved-event)| See [here](../../docs/pub-sub.md#sharded-channel-moved-event)|
278
278
279
279
> :warning: You **MUST** listen to `error` events. If a client doesn't have at least one `error` listener registered and
280
280
> 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.
281
281
282
-
> The client will not emit [any other events](./docs/v3-to-v4.md#all-the-removed-events) beyond those listed above.
282
+
> The client will not emit [any other events](../../docs/v3-to-v4.md#all-the-removed-events) beyond those listed above.
283
283
284
284
## Supported Redis versions
285
285
@@ -298,18 +298,18 @@ Node Redis is supported with the following versions of Redis:
298
298
299
299
## Migration
300
300
301
-
-[From V3 to V4](docs/v3-to-v4.md)
302
-
-[From V4 to V5](docs/v4-to-v5.md)
303
-
-[V5](docs/v5.md)
301
+
-[From V3 to V4](../../docs/v3-to-v4.md)
302
+
-[From V4 to V5](../../docs/v4-to-v5.md)
303
+
-[V5](../../docs/v5.md)
304
304
305
305
## Contributing
306
306
307
-
If you'd like to contribute, check out the [contributing guide](CONTRIBUTING.md).
307
+
If you'd like to contribute, check out the [contributing guide](../../CONTRIBUTING.md).
308
308
309
309
Thank you to all the people who already contributed to Node Redis!
0 commit comments