Skip to content

Commit cbb03a9

Browse files
committed
fix links
1 parent 786abb4 commit cbb03a9

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

packages/redis/README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,13 @@ npm install redis
4545

4646
| Name | Description |
4747
| ---------------------------------------------- | ------------------------------------------------------------------------------------------- |
48-
| [`redis`](./packages/redis) | The client with all the ["redis-stack"](https://github.com/redis-stack/redis-stack) modules |
49-
| [`@redis/client`](./packages/client) | The base clients (i.e `RedisClient`, `RedisCluster`, etc.) |
50-
| [`@redis/bloom`](./packages/bloom) | [Redis Bloom](https://redis.io/docs/data-types/probabilistic/) commands |
51-
| [`@redis/json`](./packages/json) | [Redis JSON](https://redis.io/docs/data-types/json/) commands |
52-
| [`@redis/search`](./packages/search) | [RediSearch](https://redis.io/docs/interact/search-and-query/) commands |
53-
| [`@redis/time-series`](./packages/time-series) | [Redis Time-Series](https://redis.io/docs/data-types/timeseries/) commands |
54-
| [`@redis/entraid`](./packages/entraid) | Secure token-based authentication for Redis clients using Microsoft Entra ID |
48+
| [`redis`](../redis) | The client with all the ["redis-stack"](https://github.com/redis-stack/redis-stack) modules |
49+
| [`@redis/client`](../client) | The base clients (i.e `RedisClient`, `RedisCluster`, etc.) |
50+
| [`@redis/bloom`](../bloom) | [Redis Bloom](https://redis.io/docs/data-types/probabilistic/) commands |
51+
| [`@redis/json`](../json) | [Redis JSON](https://redis.io/docs/data-types/json/) commands |
52+
| [`@redis/search`](../search) | [RediSearch](https://redis.io/docs/interact/search-and-query/) commands |
53+
| [`@redis/time-series`](../time-series) | [Redis Time-Series](https://redis.io/docs/data-types/timeseries/) commands |
54+
| [`@redis/entraid`](../entraid) | Secure token-based authentication for Redis clients using Microsoft Entra ID |
5555

5656
> Looking for a high-level library to handle object mapping?
5757
> See [redis-om-node](https://github.com/redis/redis-om-node)!
@@ -83,7 +83,7 @@ createClient({
8383
```
8484

8585
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).
8787

8888
To check if the the client is connected and ready to send commands, use `client.isReady` which returns a boolean.
8989
`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();
188188

189189
### Pub/Sub
190190

191-
See the [Pub/Sub overview](./docs/pub-sub.md).
191+
See the [Pub/Sub overview](../../docs/pub-sub.md).
192192

193193
### Scan Iterator
194194

@@ -257,11 +257,11 @@ await Promise.all([
257257

258258
### Programmability
259259

260-
See the [Programmability overview](./docs/programmability.md).
260+
See the [Programmability overview](../../docs/programmability.md).
261261

262262
### Clustering
263263

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.
265265

266266
### Events
267267

@@ -274,12 +274,12 @@ The Node Redis client class is an Nodejs EventEmitter and it emits an event each
274274
| `end` | Connection has been closed (via `.disconnect()`) | _No arguments_ |
275275
| `error` | An error has occurred—usually a network issue such as "Socket closed unexpectedly" | `(error: Error)` |
276276
| `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) |
278278

279279
> :warning: You **MUST** listen to `error` events. If a client doesn't have at least one `error` listener registered and
280280
> 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.
281281
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.
283283
284284
## Supported Redis versions
285285

@@ -298,18 +298,18 @@ Node Redis is supported with the following versions of Redis:
298298
299299
## Migration
300300

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)
304304

305305
## Contributing
306306

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).
308308

309309
Thank you to all the people who already contributed to Node Redis!
310310

311311
[![Contributors](https://contrib.rocks/image?repo=redis/node-redis)](https://github.com/redis/node-redis/graphs/contributors)
312312

313313
## License
314314

315-
This repository is licensed under the "MIT" license. See [LICENSE](LICENSE).
315+
This repository is licensed under the "MIT" license. See [LICENSE](../../LICENSE).

0 commit comments

Comments
 (0)