@upstash/redis 1.14.0 → 1.15.0-next.1

package/esm/pkg/pipeline.js

@@ -17,7 +17,7 @@ import { ZMScoreCommand } from "./commands/zmscore.js";
  * **Examples:**
  *
  * ```ts
- *  const p = redis.pipeline()
+ *  const p = redis.pipeline() // or redis.multi()
  * p.set("key","value")
  * p.get("key")
  * const res = await p.exec()
@@ -40,7 +40,7 @@ import { ZMScoreCommand } from "./commands/zmscore.js";
  * ```
  */
 export class Pipeline {
-    constructor(client, commandOptions) {
+    constructor(opts) {
         Object.defineProperty(this, "client", {
             enumerable: true,
             configurable: true,
@@ -59,6 +59,12 @@ export class Pipeline {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "multiExec", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         /**
          * Send the pipeline request to upstash.
          *
@@ -77,8 +83,9 @@ export class Pipeline {
                 if (this.commands.length === 0) {
                     throw new Error("Pipeline is empty");
                 }
+                const path = this.multiExec ? ["multi-exec"] : ["pipeline"];
                 const res = (await this.client.request({
-                    path: ["pipeline"],
+                    path,
                     body: Object.values(this.commands).map((c) => c.command),
                 }));
                 return res.map(({ error, result }, i) => {
@@ -1129,9 +1136,10 @@ export class Pipeline {
             writable: true,
             value: (...args) => this.chain(new ZUnionStoreCommand(args, this.commandOptions))
         });
-        this.client = client;
+        this.client = opts.client;
         this.commands = [];
-        this.commandOptions = commandOptions;
+        this.commandOptions = opts.commandOptions;
+        this.multiExec = opts.multiExec ?? false;
     }
     /**
      * Pushes a command into the pipelien and returns a chainable instance of the

package/esm/pkg/redis.js

@@ -51,7 +51,30 @@ export class Redis {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: () => new Pipeline(this.client, this.opts)
+            value: () => new Pipeline({
+                client: this.client,
+                commandOptions: this.opts,
+                multiExec: false,
+            })
+        });
+        /**
+         * Create a new transaction to allow executing multiple steps atomically.
+         *
+         * All the commands in a transaction are serialized and executed sequentially. A request sent by
+         * another client will never be served in the middle of the execution of a Redis Transaction. This
+         * guarantees that the commands are executed as a single isolated operation.
+         *
+         * @see {@link Pipeline}
+         */
+        Object.defineProperty(this, "multi", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: () => new Pipeline({
+                client: this.client,
+                commandOptions: this.opts,
+                multiExec: true,
+            })
         });
         /**
          * @see https://redis.io/commands/append

package/package.json

@@ -3,7 +3,6 @@
   "main": "./script/platforms/nodejs.js",
   "types": "./types/platforms/nodejs.d.ts",
   "name": "@upstash/redis",
-  "version": "v1.14.0",
   "description": "An HTTP/REST based Redis client built on top of Upstash REST API.",
   "repository": {
     "type": "git",
@@ -59,5 +58,6 @@
       "require": "./script/platforms/node_with_fetch.js",
       "types": "./types/platforms/node_with_fetch.d.ts"
     }
-  }
+  },
+  "version": "1.15.0-next.1"
 }

package/script/pkg/pipeline.js

@@ -20,7 +20,7 @@ const zmscore_js_1 = require("./commands/zmscore.js");
  * **Examples:**
  *
  * ```ts
- *  const p = redis.pipeline()
+ *  const p = redis.pipeline() // or redis.multi()
  * p.set("key","value")
  * p.get("key")
  * const res = await p.exec()
@@ -43,7 +43,7 @@ const zmscore_js_1 = require("./commands/zmscore.js");
  * ```
  */
 class Pipeline {
-    constructor(client, commandOptions) {
+    constructor(opts) {
         Object.defineProperty(this, "client", {
             enumerable: true,
             configurable: true,
@@ -62,6 +62,12 @@ class Pipeline {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "multiExec", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         /**
          * Send the pipeline request to upstash.
          *
@@ -80,8 +86,9 @@ class Pipeline {
                 if (this.commands.length === 0) {
                     throw new Error("Pipeline is empty");
                 }
+                const path = this.multiExec ? ["multi-exec"] : ["pipeline"];
                 const res = (await this.client.request({
-                    path: ["pipeline"],
+                    path,
                     body: Object.values(this.commands).map((c) => c.command),
                 }));
                 return res.map(({ error, result }, i) => {
@@ -1132,9 +1139,10 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.ZUnionStoreCommand(args, this.commandOptions))
         });
-        this.client = client;
+        this.client = opts.client;
         this.commands = [];
-        this.commandOptions = commandOptions;
+        this.commandOptions = opts.commandOptions;
+        this.multiExec = opts.multiExec ?? false;
     }
     /**
      * Pushes a command into the pipelien and returns a chainable instance of the

package/script/pkg/redis.js

@@ -54,7 +54,30 @@ class Redis {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: () => new pipeline_js_1.Pipeline(this.client, this.opts)
+            value: () => new pipeline_js_1.Pipeline({
+                client: this.client,
+                commandOptions: this.opts,
+                multiExec: false,
+            })
+        });
+        /**
+         * Create a new transaction to allow executing multiple steps atomically.
+         *
+         * All the commands in a transaction are serialized and executed sequentially. A request sent by
+         * another client will never be served in the middle of the execution of a Redis Transaction. This
+         * guarantees that the commands are executed as a single isolated operation.
+         *
+         * @see {@link Pipeline}
+         */
+        Object.defineProperty(this, "multi", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: () => new pipeline_js_1.Pipeline({
+                client: this.client,
+                commandOptions: this.opts,
+                multiExec: true,
+            })
         });
         /**
          * @see https://redis.io/commands/append

package/types/pkg/pipeline.d.ts

@@ -18,7 +18,7 @@ import { CommandArgs } from "./types.js";
  * **Examples:**
  *
  * ```ts
- *  const p = redis.pipeline()
+ *  const p = redis.pipeline() // or redis.multi()
  * p.set("key","value")
  * p.get("key")
  * const res = await p.exec()
@@ -44,7 +44,12 @@ export declare class Pipeline {
     private client;
     private commands;
     private commandOptions?;
-    constructor(client: Requester, commandOptions?: CommandOptions<any, any>);
+    private multiExec;
+    constructor(opts: {
+        client: Requester;
+        commandOptions?: CommandOptions<any, any>;
+        multiExec?: boolean;
+    });
     /**
      * Send the pipeline request to upstash.
      *

package/types/pkg/redis.d.ts

@@ -40,6 +40,16 @@ export declare class Redis {
      * @see {@link Pipeline}
      */
     pipeline: () => Pipeline;
+    /**
+     * Create a new transaction to allow executing multiple steps atomically.
+     *
+     * All the commands in a transaction are serialized and executed sequentially. A request sent by
+     * another client will never be served in the middle of the execution of a Redis Transaction. This
+     * guarantees that the commands are executed as a single isolated operation.
+     *
+     * @see {@link Pipeline}
+     */
+    multi: () => Pipeline;
     /**
      * @see https://redis.io/commands/append
      */