@valkey/valkey-glide 2.0.0-rc5 → 2.0.0-rc7

package/build-ts/BaseClient.d.ts

@@ -144,6 +144,7 @@ export type ReadFrom =
  * - **Addresses**: Use the `addresses` property to specify the hostnames and ports of the server(s) to connect to.
  *   - **Cluster Mode**: In cluster mode, the client will discover other nodes based on the provided addresses.
  *   - **Standalone Mode**: In standalone mode, only the provided nodes will be used.
+ * - **Lazy Connect**: Set `lazyConnect` to `true` to defer connection establishment until the first command is sent.
  *
  * ### Security Settings
  *
@@ -210,6 +211,7 @@ export type ReadFrom =
  *     exponentBase: 2,    // Delay doubles with each retry (2^N)
  *     jitterPercent: 20,   // Optional jitter percentage
  *   },
+ *   lazyConnect: true,
  * };
  * ```
  */
@@ -326,6 +328,40 @@ export interface BaseClientConfiguration {
          */
         jitterPercent?: number;
     };
+    /**
+     * Enables lazy connection mode, where physical connections to the server(s) are deferred
+     * until the first command is sent. This can reduce startup latency and allow for client
+     * creation in disconnected environments.
+     *
+     * - **Default**: `false` – connections are established immediately during client creation.
+     *
+     * @remarks
+     * When `lazyConnect` is set to `true`, the client will not attempt to connect to the specified
+     * nodes during initialization. Instead, connections will be established only when a command is
+     * actually executed.
+     *
+     * Note that the first command executed with lazy connections may experience additional latency
+     * as it needs to establish the connection first. During this initial connection, the standard
+     * request timeout does not apply yet - instead, the connection establishment is governed by
+     * `AdvancedBaseClientConfiguration::connectionTimeout`. The request timeout (`requestTimeout`)
+     * only begins counting after the connection has been successfully established. This behavior
+     * can effectively increase the total time needed for the first command to complete.
+     *
+     * This setting applies to both standalone and cluster modes. Note that if an operation is
+     * attempted and connection fails (e.g., unreachable nodes), errors will surface at that point.
+     *
+     * @example
+     * ```typescript
+     * const client = await GlideClient.createClient({
+     *   addresses: [{ host: "localhost", port: 6379 }],
+     *   lazyConnect: true
+     * });
+     *
+     * // No connection is made yet
+     * await client.ping(); // Now the client connects and sends the command
+     * ```
+     */
+    lazyConnect?: boolean;
 }
 /**
  * Represents advanced configuration settings for a client, including connection-related options.
@@ -1598,7 +1634,7 @@ export declare class BaseClient {
      * @param start - The starting point of the range.
      * @param end - The end of the range.
      * @returns always "OK".
-     * If `start` exceeds the end of the list, or if `start` is greater than `end`, the result will be an empty list (which causes key to be removed).
+     * If `start` exceeds the end of the list, or if `start` is greater than `end`, the list is emptied and the key is removed.
      * If `end` exceeds the actual end of the list, it will be treated like the last element of the list.
      * If `key` does not exist the command will be ignored.
      *
@@ -1611,12 +1647,12 @@ export declare class BaseClient {
      */
     ltrim(key: GlideString, start: number, end: number): Promise<"OK">;
     /** Removes the first `count` occurrences of elements equal to `element` from the list stored at `key`.
-     * If `count` is positive : Removes elements equal to `element` moving from head to tail.
-     * If `count` is negative : Removes elements equal to `element` moving from tail to head.
-     * If `count` is 0 or `count` is greater than the occurrences of elements equal to `element`: Removes all elements equal to `element`.
      *
      * @param key - The key of the list.
      * @param count - The count of the occurrences of elements equal to `element` to remove.
+     * If `count` is positive : Removes elements equal to `element` moving from head to tail.
+     * If `count` is negative : Removes elements equal to `element` moving from tail to head.
+     * If `count` is 0 or `count` is greater than the occurrences of elements equal to `element`: Removes all elements equal to `element`.
      * @param element - The element to remove from the list.
      * @returns the number of the removed elements.
      * If `key` does not exist, 0 is returned.

package/build-ts/BaseClient.js

@@ -1964,7 +1964,7 @@ class BaseClient {
      * @param start - The starting point of the range.
      * @param end - The end of the range.
      * @returns always "OK".
-     * If `start` exceeds the end of the list, or if `start` is greater than `end`, the result will be an empty list (which causes key to be removed).
+     * If `start` exceeds the end of the list, or if `start` is greater than `end`, the list is emptied and the key is removed.
      * If `end` exceeds the actual end of the list, it will be treated like the last element of the list.
      * If `key` does not exist the command will be ignored.
      *
@@ -1981,12 +1981,12 @@ class BaseClient {
         });
     }
     /** Removes the first `count` occurrences of elements equal to `element` from the list stored at `key`.
-     * If `count` is positive : Removes elements equal to `element` moving from head to tail.
-     * If `count` is negative : Removes elements equal to `element` moving from tail to head.
-     * If `count` is 0 or `count` is greater than the occurrences of elements equal to `element`: Removes all elements equal to `element`.
      *
      * @param key - The key of the list.
      * @param count - The count of the occurrences of elements equal to `element` to remove.
+     * If `count` is positive : Removes elements equal to `element` moving from head to tail.
+     * If `count` is negative : Removes elements equal to `element` moving from tail to head.
+     * If `count` is 0 or `count` is greater than the occurrences of elements equal to `element`: Removes all elements equal to `element`.
      * @param element - The element to remove from the list.
      * @returns the number of the removed elements.
      * If `key` does not exist, 0 is returned.
@@ -5955,6 +5955,7 @@ class BaseClient {
             inflightRequestsLimit: options.inflightRequestsLimit,
             clientAz: options.clientAz ?? null,
             connectionRetryStrategy: options.connectionBackoff,
+            lazyConnect: options.lazyConnect ?? false,
         };
     }
     /**

package/build-ts/Batch.d.ts

@@ -714,18 +714,18 @@ export declare class BaseBatch<T extends BaseBatch<T>> {
      * @param end - The end of the range.
      *
      * Command Response - always "OK".
-     * If `start` exceeds the end of the list, or if `start` is greater than `end`, the result will be an empty list (which causes key to be removed).
+     * If `start` exceeds the end of the list, or if `start` is greater than `end`, the list is emptied and the key is removed.
      * If `end` exceeds the actual end of the list, it will be treated like the last element of the list.
      * If `key` does not exist the command will be ignored.
      */
     ltrim(key: GlideString, start: number, end: number): T;
     /** Removes the first `count` occurrences of elements equal to `element` from the list stored at `key`.
-     * If `count` is positive : Removes elements equal to `element` moving from head to tail.
-     * If `count` is negative : Removes elements equal to `element` moving from tail to head.
-     * If `count` is 0 or `count` is greater than the occurrences of elements equal to `element`: Removes all elements equal to `element`.
      *
      * @param key - The key of the list.
      * @param count - The count of the occurrences of elements equal to `element` to remove.
+     * If `count` is positive : Removes elements equal to `element` moving from head to tail.
+     * If `count` is negative : Removes elements equal to `element` moving from tail to head.
+     * If `count` is 0 or `count` is greater than the occurrences of elements equal to `element`: Removes all elements equal to `element`.
      * @param element - The element to remove from the list.
      *
      * Command Response - the number of the removed elements.

package/build-ts/Batch.js

@@ -834,7 +834,7 @@ class BaseBatch {
      * @param end - The end of the range.
      *
      * Command Response - always "OK".
-     * If `start` exceeds the end of the list, or if `start` is greater than `end`, the result will be an empty list (which causes key to be removed).
+     * If `start` exceeds the end of the list, or if `start` is greater than `end`, the list is emptied and the key is removed.
      * If `end` exceeds the actual end of the list, it will be treated like the last element of the list.
      * If `key` does not exist the command will be ignored.
      */
@@ -842,12 +842,12 @@ class BaseBatch {
         return this.addAndReturn((0, _1.createLTrim)(key, start, end));
     }
     /** Removes the first `count` occurrences of elements equal to `element` from the list stored at `key`.
-     * If `count` is positive : Removes elements equal to `element` moving from head to tail.
-     * If `count` is negative : Removes elements equal to `element` moving from tail to head.
-     * If `count` is 0 or `count` is greater than the occurrences of elements equal to `element`: Removes all elements equal to `element`.
      *
      * @param key - The key of the list.
      * @param count - The count of the occurrences of elements equal to `element` to remove.
+     * If `count` is positive : Removes elements equal to `element` moving from head to tail.
+     * If `count` is negative : Removes elements equal to `element` moving from tail to head.
+     * If `count` is 0 or `count` is greater than the occurrences of elements equal to `element`: Removes all elements equal to `element`.
      * @param element - The element to remove from the list.
      *
      * Command Response - the number of the removed elements.

package/build-ts/ProtobufMessage.d.ts

@@ -1953,6 +1953,9 @@ export namespace connection_request {
 
         /** ConnectionRequest connectionTimeout */
         connectionTimeout?: (number|null);
+
+        /** ConnectionRequest lazyConnect */
+        lazyConnect?: (boolean|null);
     }
 
     /** Represents a ConnectionRequest. */
@@ -2012,6 +2015,9 @@ export namespace connection_request {
         /** ConnectionRequest connectionTimeout. */
         public connectionTimeout: number;
 
+        /** ConnectionRequest lazyConnect. */
+        public lazyConnect: boolean;
+
         /** ConnectionRequest periodicChecks. */
         public periodicChecks?: ("periodicChecksManualInterval"|"periodicChecksDisabled");
 

package/build-ts/ProtobufMessage.js

@@ -4115,6 +4115,7 @@ $root.connection_request = (function() {
          * @property {number|null} [inflightRequestsLimit] ConnectionRequest inflightRequestsLimit
          * @property {string|null} [clientAz] ConnectionRequest clientAz
          * @property {number|null} [connectionTimeout] ConnectionRequest connectionTimeout
+         * @property {boolean|null} [lazyConnect] ConnectionRequest lazyConnect
          */
 
         /**
@@ -4261,6 +4262,14 @@ $root.connection_request = (function() {
          */
         ConnectionRequest.prototype.connectionTimeout = 0;
 
+        /**
+         * ConnectionRequest lazyConnect.
+         * @member {boolean} lazyConnect
+         * @memberof connection_request.ConnectionRequest
+         * @instance
+         */
+        ConnectionRequest.prototype.lazyConnect = false;
+
         // OneOf field names bound to virtual getters and setters
         var $oneOfFields;
 
@@ -4332,6 +4341,8 @@ $root.connection_request = (function() {
                 writer.uint32(/* id 15, wireType 2 =*/122).string(message.clientAz);
             if (message.connectionTimeout != null && Object.hasOwnProperty.call(message, "connectionTimeout"))
                 writer.uint32(/* id 16, wireType 0 =*/128).uint32(message.connectionTimeout);
+            if (message.lazyConnect != null && Object.hasOwnProperty.call(message, "lazyConnect"))
+                writer.uint32(/* id 17, wireType 0 =*/136).bool(message.lazyConnect);
             return writer;
         };
 
@@ -4434,6 +4445,10 @@ $root.connection_request = (function() {
                         message.connectionTimeout = reader.uint32();
                         break;
                     }
+                case 17: {
+                        message.lazyConnect = reader.bool();
+                        break;
+                    }
                 default:
                     reader.skipType(tag & 7);
                     break;

package/package.json

@@ -4,7 +4,7 @@
   "main": "build-ts/index.js",
   "module": "build-ts/index.js",
   "types": "build-ts/index.d.ts",
-  "version": "2.0.0-rc5",
+  "version": "2.0.0-rc7",
   "exports": {
     ".": {
       "import": {
@@ -133,11 +133,11 @@
     }
   },
   "optionalDependencies": {
-    "@valkey/valkey-glide-darwin-x64": "2.0.0-rc5",
-    "@valkey/valkey-glide-darwin-arm64": "2.0.0-rc5",
-    "@valkey/valkey-glide-linux-x64-gnu": "2.0.0-rc5",
-    "@valkey/valkey-glide-linux-arm64-gnu": "2.0.0-rc5",
-    "@valkey/valkey-glide-linux-x64-musl": "2.0.0-rc5",
-    "@valkey/valkey-glide-linux-arm64-musl": "2.0.0-rc5"
+    "@valkey/valkey-glide-darwin-x64": "2.0.0-rc7",
+    "@valkey/valkey-glide-darwin-arm64": "2.0.0-rc7",
+    "@valkey/valkey-glide-linux-x64-gnu": "2.0.0-rc7",
+    "@valkey/valkey-glide-linux-arm64-gnu": "2.0.0-rc7",
+    "@valkey/valkey-glide-linux-x64-musl": "2.0.0-rc7",
+    "@valkey/valkey-glide-linux-arm64-musl": "2.0.0-rc7"
   }
 }