Have client.connect() return a Promise<RedisClient>

README.md

@@ -51,11 +51,9 @@ Looking for a high-level library to handle object mapping? See [redis-om-node](h
 ```typescript
 import { createClient } from 'redis';
 
-const client = createClient();
-
-client.on('error', err => console.log('Redis Client Error', err));
-
-await client.connect();
+const client = await createClient()
+  .on('error', err => console.log('Redis Client Error', err))
+  .connect();
 
 await client.set('key', 'value');
 const value = await client.get('key');
@@ -70,13 +68,6 @@ createClient({
 });
 ```
 
-You can create the client and connect it in a single line, but if you do so and it throws an error it will halt the whole Node process:
-
-```typescript
-// In this example an error connecting will throw
-const client = await createClient().connect();
-```
-
 You can also use discrete parameters, UNIX sockets, and even TLS to connect. Details can be found in the [client configuration guide](./docs/client-configuration.md).
 
 To check if the the client is connected and ready to send commands, use `client.isReady` which returns a boolean. `client.isOpen` is also available.  This returns `true` when the client's underlying socket is open, and `false` when it isn't (for example when the client is still connecting or reconnecting after a network error).

packages/client/lib/client/index.spec.ts

@@ -108,10 +108,12 @@ describe('Client', () => {
     });
 
     describe('connect', () => {
-        testUtils.testWithClient('connect returns an instance', async (client) => {
-            const client2 = await client.connect();
-            assert.equal(client, client2);
-            await client.disconnect();
+        testUtils.testWithClient('connect should return the clietn instance', async client => {
+            try {
+                assert.equal(await client.connect(), client);
+            } finally {
+                if (client.isOpen) await client.disconnect();
+            }
         }, {
             ...GLOBAL.SERVERS.PASSWORD,
             disableClientSetup: true

packages/client/lib/client/index.ts

@@ -426,7 +426,7 @@ export default class RedisClient<
         });
     }
 
-    async connect(): Promise<RedisClient<M, F, S>> {
+    async connect(): Promise<RedisClientType<M, F, S>> {
         // see comment in constructor
         this.#isolationPool ??= this.#initiateIsolationPool();
         await this.#socket.connect();