@upstash/redis 0.0.0-ci.fcd85d60 → 0.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (165) hide show
  1. package/README.md +44 -280
  2. package/esm/deps/deno.land/x/base64@v0.2.1/base.js +100 -0
  3. package/esm/deps/deno.land/x/base64@v0.2.1/base64url.js +9 -0
  4. package/esm/deps/deno.land/x/sha1@v1.0.3/deps.js +1 -0
  5. package/esm/deps/deno.land/x/sha1@v1.0.3/mod.js +191 -0
  6. package/esm/deps/denopkg.com/chiefbiiko/std-encoding@v1.0.0/mod.js +50 -0
  7. package/esm/pkg/commands/command.js +12 -3
  8. package/esm/pkg/commands/getdel.js +9 -0
  9. package/esm/pkg/commands/hgetall.js +0 -4
  10. package/esm/pkg/commands/hrandfield.js +39 -0
  11. package/esm/pkg/commands/json_arrappend.js +9 -0
  12. package/esm/pkg/commands/json_arrindex.js +9 -0
  13. package/esm/pkg/commands/json_arrinsert.js +9 -0
  14. package/esm/pkg/commands/json_arrlen.js +9 -0
  15. package/esm/pkg/commands/json_arrpop.js +9 -0
  16. package/esm/pkg/commands/json_arrtrim.js +12 -0
  17. package/esm/pkg/commands/json_clear.js +9 -0
  18. package/esm/pkg/commands/json_del.js +9 -0
  19. package/esm/pkg/commands/json_forget.js +9 -0
  20. package/esm/pkg/commands/json_get.js +30 -0
  21. package/esm/pkg/commands/json_mget.js +9 -0
  22. package/esm/pkg/commands/json_numincrby.js +9 -0
  23. package/esm/pkg/commands/json_nummultby.js +9 -0
  24. package/esm/pkg/commands/json_objkeys.js +9 -0
  25. package/esm/pkg/commands/json_objlen.js +9 -0
  26. package/esm/pkg/commands/json_resp.js +9 -0
  27. package/esm/pkg/commands/json_set.js +18 -0
  28. package/esm/pkg/commands/json_strappend.js +9 -0
  29. package/esm/pkg/commands/json_strlen.js +9 -0
  30. package/esm/pkg/commands/json_toggle.js +9 -0
  31. package/esm/pkg/commands/json_type.js +9 -0
  32. package/esm/pkg/commands/lmove.js +9 -0
  33. package/esm/pkg/commands/lpos.js +19 -0
  34. package/esm/pkg/commands/mod.js +27 -0
  35. package/esm/pkg/commands/scan.js +3 -0
  36. package/esm/pkg/commands/sdiffstore.js +1 -1
  37. package/esm/pkg/commands/set.js +16 -4
  38. package/esm/pkg/commands/smismember.js +9 -0
  39. package/esm/pkg/commands/xadd.js +26 -0
  40. package/esm/pkg/commands/zdiffstore.js +9 -0
  41. package/esm/pkg/commands/zmscore.js +10 -0
  42. package/esm/pkg/commands/zrange.js +6 -0
  43. package/esm/pkg/http.js +134 -9
  44. package/esm/pkg/pipeline.js +180 -12
  45. package/esm/pkg/redis.js +227 -2
  46. package/esm/pkg/script.js +77 -0
  47. package/esm/platforms/cloudflare.js +14 -26
  48. package/esm/platforms/fastly.js +10 -25
  49. package/esm/platforms/node_with_fetch.js +30 -26
  50. package/esm/platforms/nodejs.js +28 -26
  51. package/esm/version.js +1 -0
  52. package/package.json +53 -58
  53. package/script/deps/deno.land/x/base64@v0.2.1/base.js +104 -0
  54. package/script/deps/deno.land/x/base64@v0.2.1/base64url.js +13 -0
  55. package/script/deps/deno.land/x/sha1@v1.0.3/deps.js +6 -0
  56. package/script/deps/deno.land/x/sha1@v1.0.3/mod.js +196 -0
  57. package/script/deps/denopkg.com/chiefbiiko/std-encoding@v1.0.0/mod.js +55 -0
  58. package/script/pkg/commands/command.js +12 -3
  59. package/script/pkg/commands/getdel.js +13 -0
  60. package/script/pkg/commands/hgetall.js +0 -4
  61. package/script/pkg/commands/hrandfield.js +43 -0
  62. package/script/pkg/commands/json_arrappend.js +13 -0
  63. package/script/pkg/commands/json_arrindex.js +13 -0
  64. package/script/pkg/commands/json_arrinsert.js +13 -0
  65. package/script/pkg/commands/json_arrlen.js +13 -0
  66. package/script/pkg/commands/json_arrpop.js +13 -0
  67. package/script/pkg/commands/json_arrtrim.js +16 -0
  68. package/script/pkg/commands/json_clear.js +13 -0
  69. package/script/pkg/commands/json_del.js +13 -0
  70. package/script/pkg/commands/json_forget.js +13 -0
  71. package/script/pkg/commands/json_get.js +34 -0
  72. package/script/pkg/commands/json_mget.js +13 -0
  73. package/script/pkg/commands/json_numincrby.js +13 -0
  74. package/script/pkg/commands/json_nummultby.js +13 -0
  75. package/script/pkg/commands/json_objkeys.js +13 -0
  76. package/script/pkg/commands/json_objlen.js +13 -0
  77. package/script/pkg/commands/json_resp.js +13 -0
  78. package/script/pkg/commands/json_set.js +22 -0
  79. package/script/pkg/commands/json_strappend.js +13 -0
  80. package/script/pkg/commands/json_strlen.js +13 -0
  81. package/script/pkg/commands/json_toggle.js +13 -0
  82. package/script/pkg/commands/json_type.js +13 -0
  83. package/script/pkg/commands/lmove.js +13 -0
  84. package/script/pkg/commands/lpos.js +23 -0
  85. package/script/pkg/commands/mod.js +27 -0
  86. package/script/pkg/commands/scan.js +3 -0
  87. package/script/pkg/commands/sdiffstore.js +1 -1
  88. package/script/pkg/commands/set.js +16 -4
  89. package/script/pkg/commands/smismember.js +13 -0
  90. package/script/pkg/commands/xadd.js +30 -0
  91. package/script/pkg/commands/zdiffstore.js +13 -0
  92. package/script/pkg/commands/zmscore.js +14 -0
  93. package/script/pkg/commands/zrange.js +6 -0
  94. package/script/pkg/http.js +134 -9
  95. package/script/pkg/pipeline.js +179 -11
  96. package/script/pkg/redis.js +226 -1
  97. package/script/pkg/script.js +81 -0
  98. package/script/platforms/cloudflare.js +14 -26
  99. package/script/platforms/fastly.js +10 -25
  100. package/script/platforms/node_with_fetch.js +30 -26
  101. package/script/platforms/nodejs.js +28 -26
  102. package/script/version.js +4 -0
  103. package/types/deps/deno.land/x/base64@v0.2.1/base.d.ts +5 -0
  104. package/types/deps/deno.land/x/base64@v0.2.1/base64url.d.ts +1 -0
  105. package/types/deps/deno.land/x/sha1@v1.0.3/deps.d.ts +1 -0
  106. package/types/deps/deno.land/x/sha1@v1.0.3/mod.d.ts +26 -0
  107. package/types/deps/denopkg.com/chiefbiiko/std-encoding@v1.0.0/mod.d.ts +3 -0
  108. package/types/pkg/commands/bitop.d.ts +0 -1
  109. package/types/pkg/commands/bitpos.d.ts +1 -1
  110. package/types/pkg/commands/command.d.ts +5 -5
  111. package/types/pkg/commands/getdel.d.ts +7 -0
  112. package/types/pkg/commands/hdel.d.ts +1 -1
  113. package/types/pkg/commands/hrandfield.d.ts +9 -0
  114. package/types/pkg/commands/json_arrappend.d.ts +7 -0
  115. package/types/pkg/commands/json_arrindex.d.ts +13 -0
  116. package/types/pkg/commands/json_arrinsert.d.ts +7 -0
  117. package/types/pkg/commands/json_arrlen.d.ts +7 -0
  118. package/types/pkg/commands/json_arrpop.d.ts +7 -0
  119. package/types/pkg/commands/json_arrtrim.d.ts +7 -0
  120. package/types/pkg/commands/json_clear.d.ts +7 -0
  121. package/types/pkg/commands/json_del.d.ts +7 -0
  122. package/types/pkg/commands/json_forget.d.ts +7 -0
  123. package/types/pkg/commands/json_get.d.ts +15 -0
  124. package/types/pkg/commands/json_mget.d.ts +7 -0
  125. package/types/pkg/commands/json_numincrby.d.ts +7 -0
  126. package/types/pkg/commands/json_nummultby.d.ts +7 -0
  127. package/types/pkg/commands/json_objkeys.d.ts +7 -0
  128. package/types/pkg/commands/json_objlen.d.ts +7 -0
  129. package/types/pkg/commands/json_resp.d.ts +7 -0
  130. package/types/pkg/commands/json_set.d.ts +18 -0
  131. package/types/pkg/commands/json_strappend.d.ts +7 -0
  132. package/types/pkg/commands/json_strlen.d.ts +7 -0
  133. package/types/pkg/commands/json_toggle.d.ts +7 -0
  134. package/types/pkg/commands/json_type.d.ts +7 -0
  135. package/types/pkg/commands/lmove.d.ts +12 -0
  136. package/types/pkg/commands/lpop.d.ts +1 -1
  137. package/types/pkg/commands/lpos.d.ts +15 -0
  138. package/types/pkg/commands/mget.d.ts +1 -1
  139. package/types/pkg/commands/mod.d.ts +27 -0
  140. package/types/pkg/commands/rpop.d.ts +2 -2
  141. package/types/pkg/commands/scan.d.ts +2 -1
  142. package/types/pkg/commands/script_flush.d.ts +1 -1
  143. package/types/pkg/commands/sdiffstore.d.ts +1 -1
  144. package/types/pkg/commands/set.d.ts +31 -2
  145. package/types/pkg/commands/smembers.d.ts +2 -2
  146. package/types/pkg/commands/smismember.d.ts +7 -0
  147. package/types/pkg/commands/spop.d.ts +2 -2
  148. package/types/pkg/commands/type.d.ts +1 -1
  149. package/types/pkg/commands/xadd.d.ts +31 -0
  150. package/types/pkg/commands/zadd.d.ts +4 -4
  151. package/types/pkg/commands/zdiffstore.d.ts +7 -0
  152. package/types/pkg/commands/zinterstore.d.ts +1 -1
  153. package/types/pkg/commands/zmscore.d.ts +7 -0
  154. package/types/pkg/commands/zrange.d.ts +8 -1
  155. package/types/pkg/commands/zunionstore.d.ts +1 -1
  156. package/types/pkg/http.d.ts +73 -8
  157. package/types/pkg/pipeline.d.ts +262 -124
  158. package/types/pkg/redis.d.ts +162 -19
  159. package/types/pkg/script.d.ts +42 -0
  160. package/types/pkg/types.d.ts +27 -1
  161. package/types/platforms/cloudflare.d.ts +9 -4
  162. package/types/platforms/fastly.d.ts +3 -3
  163. package/types/platforms/node_with_fetch.d.ts +3 -3
  164. package/types/platforms/nodejs.d.ts +19 -3
  165. package/types/version.d.ts +1 -0
@@ -22,32 +22,157 @@ class HttpClient {
22
22
  writable: true,
23
23
  value: void 0
24
24
  });
25
+ Object.defineProperty(this, "retry", {
26
+ enumerable: true,
27
+ configurable: true,
28
+ writable: true,
29
+ value: void 0
30
+ });
31
+ this.options = {
32
+ backend: config.options?.backend,
33
+ agent: config.agent,
34
+ responseEncoding: config.responseEncoding ?? "base64",
35
+ cache: config.cache,
36
+ };
25
37
  this.baseUrl = config.baseUrl.replace(/\/$/, "");
26
- this.headers = { "Content-Type": "application/json", ...config.headers };
27
- this.options = config.options;
38
+ this.headers = {
39
+ "Content-Type": "application/json",
40
+ ...config.headers,
41
+ };
42
+ if (this.options.responseEncoding === "base64") {
43
+ this.headers["Upstash-Encoding"] = "base64";
44
+ }
45
+ if (typeof config?.retry === "boolean" && config?.retry === false) {
46
+ this.retry = {
47
+ attempts: 1,
48
+ backoff: () => 0,
49
+ };
50
+ }
51
+ else {
52
+ this.retry = {
53
+ attempts: config?.retry?.retries ?? 5,
54
+ backoff: config?.retry?.backoff ??
55
+ ((retryCount) => Math.exp(retryCount) * 50),
56
+ };
57
+ }
28
58
  }
29
- async request(req) {
30
- if (!req.path) {
31
- req.path = [];
59
+ mergeTelemetry(telemetry) {
60
+ function merge(obj, key, value) {
61
+ if (!value) {
62
+ return obj;
63
+ }
64
+ if (obj[key]) {
65
+ obj[key] = [obj[key], value].join(",");
66
+ }
67
+ else {
68
+ obj[key] = value;
69
+ }
70
+ return obj;
32
71
  }
72
+ this.headers = merge(this.headers, "Upstash-Telemetry-Runtime", telemetry.runtime);
73
+ this.headers = merge(this.headers, "Upstash-Telemetry-Platform", telemetry.platform);
74
+ this.headers = merge(this.headers, "Upstash-Telemetry-Sdk", telemetry.sdk);
75
+ }
76
+ async request(req) {
33
77
  const requestOptions = {
78
+ cache: this.options.cache,
34
79
  method: "POST",
35
80
  headers: this.headers,
36
81
  body: JSON.stringify(req.body),
37
82
  keepalive: true,
83
+ agent: this.options?.agent,
38
84
  /**
39
85
  * Fastly specific
40
86
  */
41
87
  backend: this.options?.backend,
42
88
  };
43
- // fetch is defined by isomorphic fetch
44
- // eslint-disable-next-line no-undef
45
- const res = await fetch([this.baseUrl, ...req.path].join("/"), requestOptions);
89
+ let res = null;
90
+ let error = null;
91
+ for (let i = 0; i <= this.retry.attempts; i++) {
92
+ try {
93
+ res = await fetch([this.baseUrl, ...(req.path ?? [])].join("/"), requestOptions);
94
+ break;
95
+ }
96
+ catch (err) {
97
+ error = err;
98
+ await new Promise((r) => setTimeout(r, this.retry.backoff(i)));
99
+ }
100
+ }
101
+ if (!res) {
102
+ throw error ?? new Error("Exhausted all retries");
103
+ }
46
104
  const body = (await res.json());
47
105
  if (!res.ok) {
48
- throw new error_js_1.UpstashError(body.error);
106
+ throw new error_js_1.UpstashError(`${body.error}, command was: ${JSON.stringify(req.body)}`);
107
+ }
108
+ if (this.options?.responseEncoding === "base64") {
109
+ if (Array.isArray(body)) {
110
+ return body.map(({ result, error }) => ({
111
+ result: decode(result),
112
+ error,
113
+ }));
114
+ }
115
+ const result = decode(body.result);
116
+ return { result, error: body.error };
49
117
  }
50
118
  return body;
51
119
  }
52
120
  }
53
121
  exports.HttpClient = HttpClient;
122
+ function base64decode(b64) {
123
+ let dec = "";
124
+ try {
125
+ /**
126
+ * Using only atob() is not enough because it doesn't work with unicode characters
127
+ */
128
+ const binString = atob(b64);
129
+ const size = binString.length;
130
+ const bytes = new Uint8Array(size);
131
+ for (let i = 0; i < size; i++) {
132
+ bytes[i] = binString.charCodeAt(i);
133
+ }
134
+ dec = new TextDecoder().decode(bytes);
135
+ }
136
+ catch {
137
+ dec = b64;
138
+ }
139
+ return dec;
140
+ // try {
141
+ // return decodeURIComponent(dec);
142
+ // } catch {
143
+ // return dec;
144
+ // }
145
+ }
146
+ function decode(raw) {
147
+ let result = undefined;
148
+ switch (typeof raw) {
149
+ case "undefined":
150
+ return raw;
151
+ case "number": {
152
+ result = raw;
153
+ break;
154
+ }
155
+ case "object": {
156
+ if (Array.isArray(raw)) {
157
+ result = raw.map((v) => typeof v === "string"
158
+ ? base64decode(v)
159
+ : Array.isArray(v)
160
+ ? v.map(decode)
161
+ : v);
162
+ }
163
+ else {
164
+ // If it's not an array it must be null
165
+ // Apparently null is an object in javascript
166
+ result = null;
167
+ }
168
+ break;
169
+ }
170
+ case "string": {
171
+ result = raw === "OK" ? "OK" : base64decode(raw);
172
+ break;
173
+ }
174
+ default:
175
+ break;
176
+ }
177
+ return result;
178
+ }
@@ -3,6 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.Pipeline = void 0;
4
4
  const mod_js_1 = require("./commands/mod.js");
5
5
  const error_js_1 = require("./error.js");
6
+ const zmscore_js_1 = require("./commands/zmscore.js");
7
+ const hrandfield_js_1 = require("./commands/hrandfield.js");
8
+ const zdiffstore_js_1 = require("./commands/zdiffstore.js");
6
9
  /**
7
10
  * Upstash REST API supports command pipelining to send multiple commands in
8
11
  * batch, instead of sending each command one by one and waiting for a response.
@@ -19,7 +22,7 @@ const error_js_1 = require("./error.js");
19
22
  * **Examples:**
20
23
  *
21
24
  * ```ts
22
- * const p = redis.pipeline()
25
+ * const p = redis.pipeline() // or redis.multi()
23
26
  * p.set("key","value")
24
27
  * p.get("key")
25
28
  * const res = await p.exec()
@@ -31,7 +34,7 @@ const error_js_1 = require("./error.js");
31
34
  * const res = await p.set("key","value").get("key").exec()
32
35
  * ```
33
36
  *
34
- * It's not possible to infer correct types with a dynamic pipeline, so you can
37
+ * Return types are inferred if all commands are chained, but you can still
35
38
  * override the response type manually:
36
39
  * ```ts
37
40
  * redis.pipeline()
@@ -42,7 +45,7 @@ const error_js_1 = require("./error.js");
42
45
  * ```
43
46
  */
44
47
  class Pipeline {
45
- constructor(client, commandOptions) {
48
+ constructor(opts) {
46
49
  Object.defineProperty(this, "client", {
47
50
  enumerable: true,
48
51
  configurable: true,
@@ -61,14 +64,22 @@ class Pipeline {
61
64
  writable: true,
62
65
  value: void 0
63
66
  });
67
+ Object.defineProperty(this, "multiExec", {
68
+ enumerable: true,
69
+ configurable: true,
70
+ writable: true,
71
+ value: void 0
72
+ });
64
73
  /**
65
74
  * Send the pipeline request to upstash.
66
75
  *
67
76
  * Returns an array with the results of all pipelined commands.
68
77
  *
69
- * You can define a return type manually to make working in typescript easier
78
+ * If all commands are statically chained from start to finish, types are inferred. You can still define a return type manually if necessary though:
70
79
  * ```ts
71
- * redis.pipeline().get("key").exec<[{ greeting: string }]>()
80
+ * const p = redis.pipeline()
81
+ * p.get("key")
82
+ * const result = p.exec<[{ greeting: string }]>()
72
83
  * ```
73
84
  */
74
85
  Object.defineProperty(this, "exec", {
@@ -79,10 +90,12 @@ class Pipeline {
79
90
  if (this.commands.length === 0) {
80
91
  throw new Error("Pipeline is empty");
81
92
  }
93
+ const path = this.multiExec ? ["multi-exec"] : ["pipeline"];
82
94
  const res = (await this.client.request({
83
- path: ["pipeline"],
95
+ path,
84
96
  body: Object.values(this.commands).map((c) => c.command),
85
97
  }));
98
+ console.log("after req", { res });
86
99
  return res.map(({ error, result }, i) => {
87
100
  if (error) {
88
101
  throw new error_js_1.UpstashError(`Command ${i + 1} [ ${this.commands[i].command[0]} ] failed: ${error}`);
@@ -127,6 +140,15 @@ class Pipeline {
127
140
  writable: true,
128
141
  value: (...args) => this.chain(new mod_js_1.BitPosCommand(args, this.commandOptions))
129
142
  });
143
+ /**
144
+ * @see https://redis.io/commands/zdiffstore
145
+ */
146
+ Object.defineProperty(this, "zdiffstore", {
147
+ enumerable: true,
148
+ configurable: true,
149
+ writable: true,
150
+ value: (...args) => this.chain(new zdiffstore_js_1.ZDiffStoreCommand(args, this.commandOptions))
151
+ });
130
152
  /**
131
153
  * @see https://redis.io/commands/dbsize
132
154
  */
@@ -253,6 +275,15 @@ class Pipeline {
253
275
  writable: true,
254
276
  value: (...args) => this.chain(new mod_js_1.GetBitCommand(args, this.commandOptions))
255
277
  });
278
+ /**
279
+ * @see https://redis.io/commands/getdel
280
+ */
281
+ Object.defineProperty(this, "getdel", {
282
+ enumerable: true,
283
+ configurable: true,
284
+ writable: true,
285
+ value: (...args) => this.chain(new mod_js_1.GetDelCommand(args, this.commandOptions))
286
+ });
256
287
  /**
257
288
  * @see https://redis.io/commands/getrange
258
289
  */
@@ -361,6 +392,15 @@ class Pipeline {
361
392
  writable: true,
362
393
  value: (key, kv) => this.chain(new mod_js_1.HMSetCommand([key, kv], this.commandOptions))
363
394
  });
395
+ /**
396
+ * @see https://redis.io/commands/hrandfield
397
+ */
398
+ Object.defineProperty(this, "hrandfield", {
399
+ enumerable: true,
400
+ configurable: true,
401
+ writable: true,
402
+ value: (key, count, withValues) => this.chain(new hrandfield_js_1.HRandFieldCommand([key, count, withValues], this.commandOptions))
403
+ });
364
404
  /**
365
405
  * @see https://redis.io/commands/hscan
366
406
  */
@@ -469,6 +509,15 @@ class Pipeline {
469
509
  writable: true,
470
510
  value: (...args) => this.chain(new mod_js_1.LLenCommand(args, this.commandOptions))
471
511
  });
512
+ /**
513
+ * @see https://redis.io/commands/lmove
514
+ */
515
+ Object.defineProperty(this, "lmove", {
516
+ enumerable: true,
517
+ configurable: true,
518
+ writable: true,
519
+ value: (...args) => this.chain(new mod_js_1.LMoveCommand(args, this.commandOptions))
520
+ });
472
521
  /**
473
522
  * @see https://redis.io/commands/lpop
474
523
  */
@@ -478,6 +527,15 @@ class Pipeline {
478
527
  writable: true,
479
528
  value: (...args) => this.chain(new mod_js_1.LPopCommand(args, this.commandOptions))
480
529
  });
530
+ /**
531
+ * @see https://redis.io/commands/lpos
532
+ */
533
+ Object.defineProperty(this, "lpos", {
534
+ enumerable: true,
535
+ configurable: true,
536
+ writable: true,
537
+ value: (...args) => this.chain(new mod_js_1.LPosCommand(args, this.commandOptions))
538
+ });
481
539
  /**
482
540
  * @see https://redis.io/commands/lpush
483
541
  */
@@ -829,6 +887,15 @@ class Pipeline {
829
887
  writable: true,
830
888
  value: (...args) => this.chain(new mod_js_1.SMembersCommand(args, this.commandOptions))
831
889
  });
890
+ /**
891
+ * @see https://redis.io/commands/smismember
892
+ */
893
+ Object.defineProperty(this, "smismember", {
894
+ enumerable: true,
895
+ configurable: true,
896
+ writable: true,
897
+ value: (key, members) => this.chain(new mod_js_1.SMIsMemberCommand([key, members], this.commandOptions))
898
+ });
832
899
  /**
833
900
  * @see https://redis.io/commands/smove
834
901
  */
@@ -1005,6 +1072,15 @@ class Pipeline {
1005
1072
  writable: true,
1006
1073
  value: (...args) => this.chain(new mod_js_1.ZLexCountCommand(args, this.commandOptions))
1007
1074
  });
1075
+ /**
1076
+ * @see https://redis.io/commands/zmscore
1077
+ */
1078
+ Object.defineProperty(this, "zmscore", {
1079
+ enumerable: true,
1080
+ configurable: true,
1081
+ writable: true,
1082
+ value: (...args) => this.chain(new zmscore_js_1.ZMScoreCommand(args, this.commandOptions))
1083
+ });
1008
1084
  /**
1009
1085
  * @see https://redis.io/commands/zpopmax
1010
1086
  */
@@ -1113,17 +1189,109 @@ class Pipeline {
1113
1189
  writable: true,
1114
1190
  value: (...args) => this.chain(new mod_js_1.ZUnionStoreCommand(args, this.commandOptions))
1115
1191
  });
1116
- this.client = client;
1117
- this.commands = [];
1118
- this.commandOptions = commandOptions;
1192
+ this.client = opts.client;
1193
+ this.commands = []; // the TCommands generic in the class definition is only used for carrying through chained command types and should never be explicitly set when instantiating the class
1194
+ this.commandOptions = opts.commandOptions;
1195
+ this.multiExec = opts.multiExec ?? false;
1119
1196
  }
1120
1197
  /**
1121
- * Pushes a command into the pipelien and returns a chainable instance of the
1198
+ * Pushes a command into the pipeline and returns a chainable instance of the
1122
1199
  * pipeline
1123
1200
  */
1124
1201
  chain(command) {
1125
1202
  this.commands.push(command);
1126
- return this;
1203
+ return this; // TS thinks we're returning Pipeline<[]> here, because we're not creating a new instance of the class, hence the cast
1204
+ }
1205
+ /**
1206
+ * @see https://redis.io/commands/?group=json
1207
+ */
1208
+ get json() {
1209
+ return {
1210
+ /**
1211
+ * @see https://redis.io/commands/json.arrappend
1212
+ */
1213
+ arrappend: (...args) => this.chain(new mod_js_1.JsonArrAppendCommand(args, this.commandOptions)),
1214
+ /**
1215
+ * @see https://redis.io/commands/json.arrindex
1216
+ */
1217
+ arrindex: (...args) => this.chain(new mod_js_1.JsonArrIndexCommand(args, this.commandOptions)),
1218
+ /**
1219
+ * @see https://redis.io/commands/json.arrinsert
1220
+ */
1221
+ arrinsert: (...args) => this.chain(new mod_js_1.JsonArrInsertCommand(args, this.commandOptions)),
1222
+ /**
1223
+ * @see https://redis.io/commands/json.arrlen
1224
+ */
1225
+ arrlen: (...args) => this.chain(new mod_js_1.JsonArrLenCommand(args, this.commandOptions)),
1226
+ /**
1227
+ * @see https://redis.io/commands/json.arrpop
1228
+ */
1229
+ arrpop: (...args) => this.chain(new mod_js_1.JsonArrPopCommand(args, this.commandOptions)),
1230
+ /**
1231
+ * @see https://redis.io/commands/json.arrtrim
1232
+ */
1233
+ arrtrim: (...args) => this.chain(new mod_js_1.JsonArrTrimCommand(args, this.commandOptions)),
1234
+ /**
1235
+ * @see https://redis.io/commands/json.clear
1236
+ */
1237
+ clear: (...args) => this.chain(new mod_js_1.JsonClearCommand(args, this.commandOptions)),
1238
+ /**
1239
+ * @see https://redis.io/commands/json.del
1240
+ */
1241
+ del: (...args) => this.chain(new mod_js_1.JsonDelCommand(args, this.commandOptions)),
1242
+ /**
1243
+ * @see https://redis.io/commands/json.forget
1244
+ */
1245
+ forget: (...args) => this.chain(new mod_js_1.JsonForgetCommand(args, this.commandOptions)),
1246
+ /**
1247
+ * @see https://redis.io/commands/json.get
1248
+ */
1249
+ get: (...args) => this.chain(new mod_js_1.JsonGetCommand(args, this.commandOptions)),
1250
+ /**
1251
+ * @see https://redis.io/commands/json.mget
1252
+ */
1253
+ mget: (...args) => this.chain(new mod_js_1.JsonMGetCommand(args, this.commandOptions)),
1254
+ /**
1255
+ * @see https://redis.io/commands/json.numincrby
1256
+ */
1257
+ numincrby: (...args) => this.chain(new mod_js_1.JsonNumIncrByCommand(args, this.commandOptions)),
1258
+ /**
1259
+ * @see https://redis.io/commands/json.nummultby
1260
+ */
1261
+ nummultby: (...args) => this.chain(new mod_js_1.JsonNumMultByCommand(args, this.commandOptions)),
1262
+ /**
1263
+ * @see https://redis.io/commands/json.objkeys
1264
+ */
1265
+ objkeys: (...args) => this.chain(new mod_js_1.JsonObjKeysCommand(args, this.commandOptions)),
1266
+ /**
1267
+ * @see https://redis.io/commands/json.objlen
1268
+ */
1269
+ objlen: (...args) => this.chain(new mod_js_1.JsonObjLenCommand(args, this.commandOptions)),
1270
+ /**
1271
+ * @see https://redis.io/commands/json.resp
1272
+ */
1273
+ resp: (...args) => this.chain(new mod_js_1.JsonRespCommand(args, this.commandOptions)),
1274
+ /**
1275
+ * @see https://redis.io/commands/json.set
1276
+ */
1277
+ set: (...args) => this.chain(new mod_js_1.JsonSetCommand(args, this.commandOptions)),
1278
+ /**
1279
+ * @see https://redis.io/commands/json.strappend
1280
+ */
1281
+ strappend: (...args) => this.chain(new mod_js_1.JsonStrAppendCommand(args, this.commandOptions)),
1282
+ /**
1283
+ * @see https://redis.io/commands/json.strlen
1284
+ */
1285
+ strlen: (...args) => this.chain(new mod_js_1.JsonStrLenCommand(args, this.commandOptions)),
1286
+ /**
1287
+ * @see https://redis.io/commands/json.toggle
1288
+ */
1289
+ toggle: (...args) => this.chain(new mod_js_1.JsonToggleCommand(args, this.commandOptions)),
1290
+ /**
1291
+ * @see https://redis.io/commands/json.type
1292
+ */
1293
+ type: (...args) => this.chain(new mod_js_1.JsonTypeCommand(args, this.commandOptions)),
1294
+ };
1127
1295
  }
1128
1296
  }
1129
1297
  exports.Pipeline = Pipeline;