Merge branch 'master' of github.com:redis/node-redis into sharded-pubsub

Author: leibale

README.md

@@ -53,7 +53,7 @@ import { createClient } from 'redis';
 
 const client = createClient();
 
-client.on('error', (err) => console.log('Redis Client Error', err));
+client.on('error', err => console.log('Redis Client Error', err));
 
 await client.connect();
 

docs/client-configuration.md

@@ -30,15 +30,31 @@
 ## Reconnect Strategy
 
 TODO: `false | number | (retries: number, cause: unknown) => number | Error`
-https://github.com/redis/node-redis/pull/2250
 
 You can implement a custom reconnect strategy as a function:
+When a network error occurs the client will automatically try to reconnect, following a default linear strategy (the more attempts, the more waiting before trying to reconnect).
+
+This strategy can be overridden by providing a `socket.reconnectStrategy` option during the client's creation.
+
+The `socket.reconnectStrategy` is a function that:
 
 - Receives the number of retries attempted so far and the causing error.
 - Returns `number | Error`:
     - `number`: wait time in milliseconds prior to attempting a reconnect.
     - `Error`: closes the client and flushes internal command queues.
 
+The example below shows the default `reconnectStrategy` and how to override it.
+
+```typescript
+import { createClient } from 'redis';
+
+const client = createClient({
+  socket: {
+    reconnectStrategy: retries => Math.min(retries * 50, 500)
+  }
+});
+```
+
 ## TLS
 
 To enable TLS, set `socket.tls` to `true`. Below are some basic examples.