Skip to content

Commit 9ee7c8d

Browse files
committed
docs: added punctuation
1 parent dbf8f59 commit 9ee7c8d

File tree

6 files changed

+13
-12
lines changed

6 files changed

+13
-12
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ To assist reviewers, we ask that you fill out the pull request template as much
6161

6262
Pull Requests to the protected branches require peer-review approvals and passing status checks to be able to be merged.
6363

64-
When reviewing a Pull Request please check the following steps as well as the existing automated checks:
64+
When reviewing a Pull Request, please check the following steps as well as the existing automated checks:
6565

6666
- Does your Pull Request provide or update the docs if docs changes are required?
6767
- Have the tests been updated or new tests been added to test any newly implemented or changed functionality?

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ node-redis is a modern, high performance [Redis](https://redis.io) client for No
3737
| [@redis/search](./packages/search) | [![Downloads](https://img.shields.io/npm/dm/@redis/search.svg)](https://www.npmjs.com/package/@redis/search) [![Version](https://img.shields.io/npm/v/@redis/search.svg)](https://www.npmjs.com/package/@redis/search) [![Docs](https://img.shields.io/badge/-documentation-dc382c)](https://redis.js.org/documentation/search/) [RediSearch](https://oss.redis.com/redisearch/) commands |
3838
| [@redis/time-series](./packages/time-series) | [![Downloads](https://img.shields.io/npm/dm/@redis/time-series.svg)](https://www.npmjs.com/package/@redis/time-series) [![Version](https://img.shields.io/npm/v/@redis/time-series.svg)](https://www.npmjs.com/package/@redis/time-series) [![Docs](https://img.shields.io/badge/-documentation-dc382c)](https://redis.js.org/documentation/time-series/) [Redis Time-Series](https://oss.redis.com/redistimeseries/) commands |
3939

40-
> :warning: In version 4.1.0 we moved our subpackages from `@node-redis` to `@redis`. If you're just using `npm install redis`, you don't need to do anything—it'll upgrade automatically. If you're using the subpackages directly, you'll need to point to the new scope (e.g. `@redis/client` instead of `@node-redis/client`).
40+
> :warning: In version 4.1.0, we moved our subpackages from `@node-redis` to `@redis`. If you're just using `npm install redis`, you don't need to do anything—it'll upgrade automatically. If you're using the subpackages directly, you'll need to point to the new scope (e.g. `@redis/client` instead of `@node-redis/client`).
4141
4242
## Installation
4343

@@ -127,7 +127,7 @@ await client.hGetAll(
127127

128128
### Unsupported Redis Commands
129129

130-
If you want to run commands and/or use arguments that Node Redis doesn't know about (yet!) use `.sendCommand()`:
130+
If you want to run commands and/or use arguments that Node Redis doesn't know about (yet!), use `.sendCommand()`:
131131

132132
```typescript
133133
await client.sendCommand(['SET', 'key', 'value', 'NX']); // 'OK'
@@ -290,7 +290,7 @@ await client.add('key', 2); // 3
290290

291291
### Disconnecting
292292

293-
There are two functions that disconnect a client from the Redis server. In most scenarios you should use `.quit()` to ensure that pending commands are sent to Redis before closing a connection.
293+
There are two functions that disconnect a client from the Redis server. In most scenarios, you should use `.quit()` to ensure that pending commands are sent to Redis before closing a connection.
294294

295295
#### `.QUIT()`/`.quit()`
296296

@@ -327,7 +327,7 @@ client.set('Tm9kZSBSZWRpcw==', 'users:1');
327327
client.sAdd('users:1:tokens', 'Tm9kZSBSZWRpcw==');
328328
```
329329

330-
Of course, if you don't do something with your Promises you're certain to get [unhandled Promise exceptions](https://nodejs.org/api/process.html#process_event_unhandledrejection). To take advantage of auto-pipelining and handle your Promises, use `Promise.all()`.
330+
Of course, if you don't do something with your Promises, you're certain to get [unhandled Promise exceptions](https://nodejs.org/api/process.html#process_event_unhandledrejection). To take advantage of auto-pipelining and handle your Promises, use `Promise.all()`.
331331

332332
```typescript
333333
await Promise.all([

docs/client-configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ When the socket closes unexpectedly (without calling `.quit()`/`.disconnect()`),
3434
2. `number` -> wait for `X` milliseconds before reconnecting.
3535
3. `(retries: number, cause: Error) => false | number | Error` -> `number` is the same as configuring a `number` directly, `Error` is the same as `false`, but with a custom error.
3636

37-
By default the strategy is `Math.min(retries * 50, 500)`, but it can be overwritten like so:
37+
By default, the strategy is `Math.min(retries * 50, 500)`, but it can be overwritten like so:
3838

3939
```javascript
4040
createClient({
@@ -48,7 +48,7 @@ createClient({
4848

4949
To enable TLS, set `socket.tls` to `true`. Below are some basic examples.
5050

51-
> For configuration options see [tls.connect](https://nodejs.org/api/tls.html#tlsconnectoptions-callback) and [tls.createSecureContext](https://nodejs.org/api/tls.html#tlscreatesecurecontextoptions), as those are the underlying functions used by this library.
51+
> For configuration options, see [tls.connect](https://nodejs.org/api/tls.html#tlsconnectoptions-callback) and [tls.createSecureContext](https://nodejs.org/api/tls.html#tlscreatesecurecontextoptions), as those are the underlying functions used by this library.
5252
5353
### Create a SSL client
5454

docs/clustering.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ const value = await cluster.get('key');
4444
## Auth with password and username
4545

4646
Specifying the password in the URL or a root node will only affect the connection to that specific node. In case you want to set the password for all the connections being created from a cluster instance, use the `defaults` option.
47+
4748
```javascript
4849
createCluster({
4950
rootNodes: [{

docs/isolated-execution.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Sometimes you want to run your commands on an exclusive connection. There are a
88

99
Below are several examples of how to use isolated execution.
1010

11-
> NOTE: Behind the scenes we're using [`generic-pool`](https://www.npmjs.com/package/generic-pool) to provide a pool of connections that can be isolated. Go there to learn more.
11+
> NOTE: Behind the scenes, we're using [`generic-pool`](https://www.npmjs.com/package/generic-pool) to provide a pool of connections that can be isolated. Go there to learn more.
1212
1313
## The Simple Scenario
1414

@@ -23,7 +23,7 @@ await client.executeIsolated(async isolatedClient => {
2323

2424
## Transactions
2525

26-
Things get a little more complex with transactions. Here we are `.watch()`ing some keys. If the keys change during the transaction, a `WatchError` is thrown when `.exec()` is called:
26+
Things get a little more complex with transactions. Here, we are `.watch()`ing some keys. If the keys change during the transaction, a `WatchError` is thrown when `.exec()` is called:
2727

2828
```typescript
2929
try {

docs/v3-to-v4.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The configuration object passed to `createClient` has changed significantly with
1616

1717
### No Auto Connect
1818

19-
In V4, the client does not automatically connect to the server. Instead you need to run `.connect()` after creating the client or you will receive an error: `ClientClosedError: The client is closed`.
19+
In V4, the client does not automatically connect to the server. Instead, you need to run `.connect()` after creating the client or you will receive an error: `ClientClosedError: The client is closed`.
2020

2121
```typescript
2222
import { createClient } from 'redis';
@@ -50,9 +50,9 @@ In V4, you don't need to add a listener to the `message`-like events (items 5 to
5050

5151
The second argument of these commands is a callback, which will be triggered every time there is a message published to the channel.
5252

53-
The third argument to these commands is a boolean to set `bufferMode` (default `false`). If it's set to `true` you will receive a buffer instead of a string.
53+
The third argument to these commands is a boolean to set `bufferMode` (default `false`). If it's set to `true`, you will receive a buffer instead of a string.
5454

55-
The `subscribe`-like commands return a promise. If the command is executed successfully the promise will be fulfilled, otherwise the promise will be rejected.
55+
The `subscribe`-like commands return a promise. If the command is executed successfully, the promise will be fulfilled, otherwise the promise will be rejected.
5656

5757
```typescript
5858
import { createClient } from 'redis';

0 commit comments

Comments
 (0)