Skip to content

Commit 708b22f

Browse files
authored
docs(readme): replace relative GitHub links with absolute URLs (#2980)
1 parent f346bad commit 708b22f

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

packages/redis/README.md

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

4646
| Name | Description |
4747
| ---------------------------------------------- | ------------------------------------------------------------------------------------------- |
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 |
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 |
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](https://github.com/redis/node-redis/blob/master/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](https://github.com/redis/node-redis/blob/master/docs/pub-sub.md).
192192

193193
### Scan Iterator
194194

@@ -250,7 +250,7 @@ const client = createClient({
250250
});
251251
```
252252

253-
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.
254254

255255
### Auto-Pipelining
256256

@@ -274,11 +274,11 @@ await Promise.all([
274274

275275
### Programmability
276276

277-
See the [Programmability overview](../../docs/programmability.md).
277+
See the [Programmability overview](https://github.com/redis/node-redis/blob/master/docs/programmability.md).
278278

279279
### Clustering
280280

281-
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.
282282

283283
### Events
284284

@@ -291,12 +291,12 @@ The Node Redis client class is an Nodejs EventEmitter and it emits an event each
291291
| `end` | Connection has been closed (via `.disconnect()`) | _No arguments_ |
292292
| `error` | An error has occurred—usually a network issue such as "Socket closed unexpectedly" | `(error: Error)` |
293293
| `reconnecting` | Client is trying to reconnect to the server | _No arguments_ |
294-
| `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) |
295295

296296
> :warning: You **MUST** listen to `error` events. If a client doesn't have at least one `error` listener registered and
297297
> 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.
298298
299-
> 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.
300300
301301
## Supported Redis versions
302302

@@ -313,18 +313,18 @@ Node Redis is supported with the following versions of Redis:
313313
314314
## Migration
315315

316-
- [From V3 to V4](../../docs/v3-to-v4.md)
317-
- [From V4 to V5](../../docs/v4-to-v5.md)
318-
- [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)
318+
- [V5](https://github.com/redis/node-redis/blob/master/docs/v5.md)
319319

320320
## Contributing
321321

322-
If you'd like to contribute, check out the [contributing guide](../../CONTRIBUTING.md).
322+
If you'd like to contribute, check out the [contributing guide](https://github.com/redis/node-redis/blob/master/CONTRIBUTING.md).
323323

324324
Thank you to all the people who already contributed to Node Redis!
325325

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

328328
## License
329329

330-
This repository is licensed under the "MIT" license. See [LICENSE](../../LICENSE).
330+
This repository is licensed under the "MIT" license. See [LICENSE](https://github.com/redis/node-redis/blob/master/LICENSE).

0 commit comments

Comments
 (0)