@upstash/redis 0.0.0-ci.f55d85c5 → 0.0.0-ci.f8d46c0e

package/README.md

@@ -11,9 +11,9 @@ It is the only connectionless (HTTP based) Redis client and designed for:
 
 - Serverless functions (AWS Lambda ...)
 - Cloudflare Workers (see
-  [the example](https://github.com/upstash/upstash-redis/tree/master/examples/cloudflare-workers))
+  [the example](https://github.com/upstash/upstash-redis/tree/main/examples/cloudflare-workers))
 - Fastly Compute@Edge (see
-  [the example](https://github.com/upstash/upstash-redis/tree/master/examples/fastly))
+  [the example](https://github.com/upstash/upstash-redis/tree/main/examples/fastly))
 - Next.js, Jamstack ...
 - Client side web/mobile applications
 - WebAssembly
@@ -23,24 +23,6 @@ See
 [the list of APIs](https://docs.upstash.com/features/restapi#rest---redis-api-compatibility)
 supported.
 
-## Upgrading to v1.4.0 **(ReferenceError: fetch is not defined)**
-
-If you are running on nodejs v17 and earlier, `fetch` will not be natively
-supported. Platforms like Vercel, Netlify, Deno, Fastly etc. provide a polyfill
-for you. But if you are running on bare node, you need to either specify a
-polyfill yourself or change the import path to:
-
-```typescript
-import { Redis } from "@upstash/redis/with-fetch";
-```
-
-## Upgrading from v0.2.0?
-
-Please read the
-[migration guide](https://github.com/upstash/upstash-redis#migrating-to-v1). For
-further explanation we wrote a
-[blog post](https://blog.upstash.com/upstash-redis-sdk-v1).
-
 ## Quick Start
 
 ### Install
@@ -61,133 +43,7 @@ import { Redis } from "https://deno.land/x/upstash_redis/mod.ts";
 
 Create a new redis database on [upstash](https://console.upstash.com/)
 
-### Environments
-
-We support various platforms, such as nodejs, cloudflare and fastly. Platforms
-differ slightly when it comes to environment variables and their `fetch` api.
-Please use the correct import when deploying to special platforms.
-
-#### Node.js
-
-Examples: Vercel, Netlify, AWS Lambda
-
-If you are running on nodejs you can set `UPSTASH_REDIS_REST_URL` and
-`UPSTASH_REDIS_REST_TOKEN` as environment variable and create a redis instance
-like this:
-
-```ts
-import { Redis } from "@upstash/redis"
-
-const redis = new Redis({
-  url: <UPSTASH_REDIS_REST_URL>,
-  token: <UPSTASH_REDIS_REST_TOKEN>,
-})
-
-// or load directly from env
-const redis = Redis.fromEnv()
-```
-
-If you are running on nodejs v17 and earlier, `fetch` will not be natively
-supported. Platforms like Vercel, Netlify, Deno, Fastly etc. provide a polyfill
-for you. But if you are running on bare node, you need to either specify a
-polyfill yourself or change the import path to:
-
-```typescript
-import { Redis } from "@upstash/redis/with-fetch";
-```
-
-- [Code example](https://github.com/upstash/upstash-redis/blob/main/examples/nodejs)
-
-#### Cloudflare Workers
-
-Cloudflare handles environment variables differently than nodejs. Please add
-`UPSTASH_REDIS_REST_URL` and `UPSTASH_REDIS_REST_TOKEN` using
-`wrangler secret put ...` or in the cloudflare dashboard.
-
-Afterwards you can create a redis instance:
-
-```ts
-import { Redis } from "@upstash/redis/cloudflare"
-
-const redis = new Redis({
-  url: <UPSTASH_REDIS_REST_URL>,
-  token: <UPSTASH_REDIS_REST_TOKEN>,
-})
-
-
-// or load directly from global env
-
-// service worker
-const redis = Redis.fromEnv()
-
-
-// module worker
-export default {
-  async fetch(request: Request, env: Bindings) {
-    const redis = Redis.fromEnv(env)
-    // ...
-  }
-}
-```
-
-- [Code example service worker](https://github.com/upstash/upstash-redis/tree/main/examples/cloudflare-workers)
-- [Code example module worker](https://github.com/upstash/upstash-redis/tree/main/examples/cloudflare-workers-modules)
-- [Documentation](https://docs.upstash.com/redis/tutorials/cloudflare_workers_with_redis)
-
-#### Fastly
-
-Fastly introduces a concept called
-[backend](https://developer.fastly.com/reference/api/services/backend/). You
-need to configure a backend in your `fastly.toml`. An example can be found
-[here](https://github.com/upstash/upstash-redis/blob/main/examples/fastly/fastly.toml).
-Until the fastly api stabilizes we recommend creating an instance manually:
-
-```ts
-import { Redis } from "@upstash/redis/fastly"
-
-const redis = new Redis({
-  url: <UPSTASH_REDIS_REST_URL>,
-  token: <UPSTASH_REDIS_REST_TOKEN>,
-  backend: <BACKEND_NAME>,
-})
-```
-
-- [Code example](https://github.com/upstash/upstash-redis/tree/main/examples/fastly)
-- [Documentation](https://blog.upstash.com/fastly-compute-edge-with-redi)
-
-#### Deno
-
-Examples: [Deno Deploy](https://deno.com/deploy),
-[Netlify Edge](https://www.netlify.com/products/edge/)
-
-```ts
-import { Redis } from "https://deno.land/x/upstash_redis/mod.ts"
-
-const redis = new Redis({
-  url: <UPSTASH_REDIS_REST_URL>,
-  token: <UPSTASH_REDIS_REST_TOKEN>,
-})
-
-// or
-const redis = Redis.fromEnv();
-```
-
-### Working with types
-
-Most commands allow you to provide a type to make working with typescript
-easier.
-
-```ts
-const data = await redis.get<MyCustomType>("key");
-// data is typed as `MyCustomType`
-```
-
-## Migrating to v1
-
-### Explicit authentication
-
-The library is no longer automatically trying to load connection secrets from
-environment variables. You must either supply them yourself:
+## Basic Usage:
 
 ```ts
 import { Redis } from "@upstash/redis"
@@ -196,146 +52,52 @@ const redis = new Redis({
   url: <UPSTASH_REDIS_REST_URL>,
   token: <UPSTASH_REDIS_REST_TOKEN>,
 })
-```
 
-Or use one of the static constructors to load from environment variables:
+// string
+await redis.set('key', 'value');
+let data = await redis.get('key');
+console.log(data)
 
-```ts
-// Nodejs
-import { Redis } from "@upstash/redis";
-const redis = Redis.fromEnv();
-```
+await redis.set('key2', 'value2', {ex: 1});
 
-```ts
-// or when deploying to cloudflare workers
-import { Redis } from "@upstash/redis/cloudflare";
-const redis = Redis.fromEnv();
-```
+// sorted set
+await redis.zadd('scores', { score: 1, member: 'team1' })
+data = await redis.zrange('scores', 0, 100 )
+console.log(data)
 
-### Error handling
+// list
+await redis.lpush('elements', 'magnesium')
+data = await redis.lrange('elements', 0, 100 )
+console.log(data)
 
-Errors are now thrown automatically instead of being returned to you.
+// hash
+await redis.hset('people', {name: 'joe'})
+data = await redis.hget('people', 'name' )
+console.log(data)
 
-```ts
-// old
-const { data, error } = await set("key", "value");
-if (error) {
-  throw new Error(error);
-}
-
-// new
-const data = await redis.set("key", "value"); // error is thrown automatically
+// sets
+await redis.sadd('animals', 'cat')
+data  = await redis.spop('animals', 1)
+console.log(data)
 ```
 
-## Pipeline
-
-`v1.0.0` introduces redis pipelines. Pipelining commands allows you to send a
-single http request with multiple commands.
-
-```ts
-import { Redis } from "@upstash/redis";
-
-const redis = new Redis({
-  /* auth */
-});
-
-const p = redis.pipeline();
+### Upgrading to v1.4.0 **(ReferenceError: fetch is not defined)**
 
-// Now you can chain multiple commands to create your pipeline:
-
-p.set("key", 2);
-p.incr("key");
-
-// or inline:
-p.hset("key2", "field", { hello: "world" }).hvals("key2");
-
-// Execute the pipeline once you are done building it:
-// `exec` returns an array where each element represents the response of a command in the pipeline.
-// You can optionally provide a type like this to get a typed response.
-const res = await p.exec<[Type1, Type2, Type3]>();
-```
-
-For more information about pipelines using REST see
-[here](https://blog.upstash.com/pipeline).
-
-### Advanced
-
-A low level `Command` class can be imported from `@upstash/redis` in case you
-need more control about types and or (de)serialization.
-
-By default all objects you are storing in redis are serialized using
-`JSON.stringify` and recursively deserialized as well. Here's an example how you
-could customize that behaviour. Keep in mind that you need to provide a `fetch`
-polyfill if you are running on nodejs. We recommend
-[isomorphic-fetch](https://www.npmjs.com/package/isomorphic-fetch).
-
-```ts
-import { Command } from "@upstash/redis/commands"
-import { HttpClient } from "@upstash/redis/http"
-
-/**
- * TData represents what the user will enter or receive,
- * TResult is the raw data returned from upstash, which may need to be
- * transformed or parsed.
- */
-const deserialize: (raw: TResult) => TData = ...
-
-class CustomGetCommand<TData, TResult> extends Command<TData | null, TResult | null> {
-  constructor(key: string, ) {
-    super(["get", key], { deserialize })
-  }
-}
-
-const client = new HttpClient({
-  baseUrl: <UPSTASH_REDIS_REST_URL>,
-  headers: {
-    authorization: `Bearer ${<UPSTASH_REDIS_REST_TOKEN>}`,
-  },
-})
-
-const res = new CustomGetCommand("key").exec(client)
-```
-
-### Additional information
-
-#### `keepalive`
-
-`@upstash/redis` is capable of reusing connections where possible to minimize
-latency. Connections can be reused if the client is stored in memory and not
-initialized with every new function invocation. The easiest way to achieve this
-is by creating the client outside of your handler and adding an https agent:
-
-```ts
-// Nextjs api route
-import { Redis } from "@upstash/redis";
-import https from "https";
-
-const redis = Redis.fromEnv({
-  agent: new https.Agent({ keepAlive: true }),
-});
+If you are running on nodejs v17 and earlier, `fetch` will not be natively
+supported. Platforms like Vercel, Netlify, Deno, Fastly etc. provide a polyfill
+for you. But if you are running on bare node, you need to either specify a
+polyfill yourself or change the import path to:
 
-export default async function (req, res) {
-  // use redis here
-}
+```typescript
+import { Redis } from "@upstash/redis/with-fetch";
 ```
 
-Whenever your hot lambda receives a new request the client is already
-initialized and the previously established connection to upstash is reused.
-
-#### Javascript MAX_SAFE_INTEGER
-
-Javascript can not handle numbers larger than `2^53 -1` safely and would return
-wrong results when trying to deserialize them. In these cases the default
-deserializer will return them as string instead. This might cause a mismatch
-with your custom types.
-
-```ts
-await redis.set("key", "101600000000150081467");
-const res = await redis<number>("get");
-```
+### Upgrading from v0.2.0?
 
-In this example `res` will still be a string despite the type annotation. Please
-keep that in mind and adjust accordingly.
+Please read the
+[migration guide](https://docs.upstash.com/redis/sdks/javascriptsdk/migration).
+For further explanation we wrote a
+[blog post](https://blog.upstash.com/upstash-redis-sdk-v1).
 
 ## Docs
 

package/esm/pkg/commands/script_exists.js

@@ -5,16 +5,7 @@ import { Command } from "./command.js";
 export class ScriptExistsCommand extends Command {
     constructor(hashes, opts) {
         super(["script", "exists", ...hashes], {
-            deserialize: (result) => {
-                /**
-                 * This isn't very pretty but it does the job.
-                 * The user facing api is clean and will return a single `string` if they provided
-                 * a single script hash, and an array of strings of the same length when given an
-                 * array of hashes.
-                 */
-                const parsed = result;
-                return parsed.length === 1 ? parsed[0] : parsed;
-            },
+            deserialize: (result) => result,
             ...opts,
         });
     }

package/esm/pkg/http.js

@@ -19,14 +19,30 @@ export class HttpClient {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "retry", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.baseUrl = config.baseUrl.replace(/\/$/, "");
         this.headers = { "Content-Type": "application/json", ...config.headers };
-        this.options = config.options;
+        this.options = { backend: config.options?.backend };
+        if (typeof config?.retry === "boolean" && config?.retry === false) {
+            this.retry = {
+                attempts: 1,
+                backoff: () => 0,
+            };
+        }
+        else {
+            this.retry = {
+                attempts: config?.retry?.retries ?? 5,
+                backoff: config?.retry?.backoff ??
+                    ((retryCount) => Math.exp(retryCount) * 50),
+            };
+        }
     }
     async request(req) {
-        if (!req.path) {
-            req.path = [];
-        }
         const requestOptions = {
             method: "POST",
             headers: this.headers,
@@ -37,9 +53,21 @@ export class HttpClient {
              */
             backend: this.options?.backend,
         };
-        // fetch is defined by isomorphic fetch
-        // eslint-disable-next-line no-undef
-        const res = await fetch([this.baseUrl, ...req.path].join("/"), requestOptions);
+        let res = null;
+        let error = null;
+        for (let i = 0; i <= this.retry.attempts; i++) {
+            try {
+                res = await fetch([this.baseUrl, ...(req.path ?? [])].join("/"), requestOptions);
+                break;
+            }
+            catch (err) {
+                error = err;
+                await new Promise((r) => setTimeout(r, this.retry.backoff(i)));
+            }
+        }
+        if (!res) {
+            throw error ?? new Error("Exhausted all retries");
+        }
         const body = (await res.json());
         if (!res.ok) {
             throw new UpstashError(body.error);

package/esm/platforms/cloudflare.js

@@ -1,5 +1,5 @@
 import * as core from "../pkg/redis.js";
-import { UpstashError } from "../pkg/error.js";
+import { HttpClient } from "../pkg/http.js";
 /**
  * Serverless redis client for upstash.
  */
@@ -26,7 +26,8 @@ export class Redis extends core.Redis {
             /\r|\n/.test(config.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
-        const client = defaultRequester({
+        const client = new HttpClient({
+            retry: config.retry,
             baseUrl: config.url,
             headers: { authorization: `Bearer ${config.token}` },
         });
@@ -44,9 +45,8 @@ export class Redis extends core.Redis {
      * ```ts
      * const redis = Redis.fromEnv(env)
      * ```
-     *
      */
-    static fromEnv(env) {
+    static fromEnv(env, opts) {
         // @ts-ignore These will be defined by cloudflare
         const url = env?.UPSTASH_REDIS_REST_URL ?? UPSTASH_REDIS_REST_URL;
         // @ts-ignore These will be defined by cloudflare
@@ -57,26 +57,6 @@ export class Redis extends core.Redis {
         if (!token) {
             throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`. Please add it via `wrangler secret put UPSTASH_REDIS_REST_TOKEN`");
         }
-        return new Redis({ url, token });
+        return new Redis({ ...opts, url, token });
     }
 }
-function defaultRequester(config) {
-    return {
-        request: async function (req) {
-            if (!req.path) {
-                req.path = [];
-            }
-            const res = await fetch([config.baseUrl, ...req.path].join("/"), {
-                method: "POST",
-                headers: { "Content-Type": "application/json", ...config.headers },
-                body: JSON.stringify(req.body),
-                keepalive: true,
-            });
-            const body = (await res.json());
-            if (!res.ok) {
-                throw new UpstashError(body.error);
-            }
-            return body;
-        },
-    };
-}

package/esm/platforms/fastly.js

@@ -1,5 +1,5 @@
 import * as core from "../pkg/redis.js";
-import { UpstashError } from "../pkg/error.js";
+import { HttpClient } from "../pkg/http.js";
 /**
  * Serverless redis client for upstash.
  */
@@ -27,35 +27,14 @@ export class Redis extends core.Redis {
             /\r|\n/.test(config.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
-        const client = defaultRequester({
+        const client = new HttpClient({
             baseUrl: config.url,
+            retry: config.retry,
             headers: { authorization: `Bearer ${config.token}` },
-            backend: config.backend,
+            options: { backend: config.backend },
         });
         super(client, {
             automaticDeserialization: config.automaticDeserialization,
         });
     }
 }
-function defaultRequester(config) {
-    return {
-        request: async function (req) {
-            if (!req.path) {
-                req.path = [];
-            }
-            const res = await fetch([config.baseUrl, ...req.path].join("/"), {
-                method: "POST",
-                headers: { "Content-Type": "application/json", ...config.headers },
-                body: JSON.stringify(req.body),
-                keepalive: true,
-                // @ts-expect-error fastly requires `backend`
-                backend: config.backend,
-            });
-            const body = (await res.json());
-            if (!res.ok) {
-                throw new UpstashError(body.error);
-            }
-            return body;
-        },
-    };
-}

package/esm/platforms/node_with_fetch.js

@@ -1,6 +1,6 @@
 // deno-lint-ignore-file
 import * as core from "../pkg/redis.js";
-import { UpstashError } from "../pkg/error.js";
+import { HttpClient, } from "../pkg/http.js";
 import "isomorphic-fetch";
 /**
  * Serverless redis client for upstash.
@@ -21,8 +21,9 @@ export class Redis extends core.Redis {
             /\r|\n/.test(configOrRequester.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
-        const client = defaultRequester({
+        const client = new HttpClient({
             baseUrl: configOrRequester.url,
+            retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
             // agent: configOrRequester.agent,
         });
@@ -54,28 +55,6 @@ export class Redis extends core.Redis {
         if (!token) {
             throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`");
         }
-        return new Redis({ url, token, ...config });
+        return new Redis({ ...config, url, token });
     }
 }
-function defaultRequester(config) {
-    return {
-        request: async function (req) {
-            if (!req.path) {
-                req.path = [];
-            }
-            const res = await fetch([config.baseUrl, ...req.path].join("/"), {
-                method: "POST",
-                headers: { "Content-Type": "application/json", ...config.headers },
-                body: JSON.stringify(req.body),
-                keepalive: true,
-                // @ts-ignore
-                agent: config.agent,
-            });
-            const body = (await res.json());
-            if (!res.ok) {
-                throw new UpstashError(body.error);
-            }
-            return body;
-        },
-    };
-}

package/esm/platforms/nodejs.js

@@ -1,6 +1,6 @@
 // deno-lint-ignore-file
 import * as core from "../pkg/redis.js";
-import { UpstashError } from "../pkg/error.js";
+import { HttpClient, } from "../pkg/http.js";
 /**
  * Serverless redis client for upstash.
  */
@@ -20,8 +20,9 @@ export class Redis extends core.Redis {
             /\r|\n/.test(configOrRequester.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
-        const client = defaultRequester({
+        const client = new HttpClient({
             baseUrl: configOrRequester.url,
+            retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
             // agent: configOrRequester.agent,
         });
@@ -53,28 +54,6 @@ export class Redis extends core.Redis {
         if (!token) {
             throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`");
         }
-        return new Redis({ url, token, ...config });
+        return new Redis({ ...config, url, token });
     }
 }
-function defaultRequester(config) {
-    return {
-        request: async function (req) {
-            if (!req.path) {
-                req.path = [];
-            }
-            const res = await fetch([config.baseUrl, ...req.path].join("/"), {
-                method: "POST",
-                headers: { "Content-Type": "application/json", ...config.headers },
-                body: JSON.stringify(req.body),
-                keepalive: true,
-                // @ts-ignore
-                agent: config.agent,
-            });
-            const body = (await res.json());
-            if (!res.ok) {
-                throw new UpstashError(body.error);
-            }
-            return body;
-        },
-    };
-}

package/package.json

@@ -3,7 +3,7 @@
   "main": "./script/platforms/nodejs.js",
   "types": "./types/platforms/nodejs.d.ts",
   "name": "@upstash/redis",
-  "version": "v0.0.0-ci.f55d85c5",
+  "version": "v0.0.0-ci.f8d46c0e",
   "description": "An HTTP/REST based Redis client built on top of Upstash REST API.",
   "repository": {
     "type": "git",
@@ -16,36 +16,43 @@
     "edge",
     "upstash"
   ],
-  "author": "Andreas Thomas <andreas.thomas@chronark.com>",
+  "author": "Andreas Thomas <dev@chronark.com>",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/upstash/upstash-redis/issues"
   },
-  "dependencies": {
-    "isomorphic-fetch": "^3.0.0"
-  },
   "homepage": "https://github.com/upstash/upstash-redis#readme",
-  "browser": {
-    "isomorphic-fetch": false,
-    "http": false,
-    "https": false
-  },
   "devDependencies": {
     "@size-limit/preset-small-lib": "latest",
     "size-limit": "latest"
   },
+  "dependencies": {
+    "isomorphic-fetch": "^3.0.0"
+  },
+  "typesVersions": {
+    "*": {
+      "nodejs": "./types/platforms/nodejs.d.ts",
+      "cloudflare": "./types/platforms/cloudflare.d.ts",
+      "fastly": "./types/platforms/fastly.d.ts",
+      "with-fetch": "./types/platforms/node_with_fetch.d.ts"
+    }
+  },
   "size-limit": [
     {
       "path": "esm/platforms/nodejs.js",
-      "limit": "5 KB"
+      "limit": "6 KB"
     },
     {
       "path": "esm/platforms/fastly.js",
-      "limit": "5 KB"
+      "limit": "6 KB"
     },
     {
       "path": "esm/platforms/cloudflare.js",
-      "limit": "5 KB"
+      "limit": "6 KB"
+    },
+    {
+      "path": "esm/platforms/node_with_fetch.js",
+      "limit": "15 KB"
     },
     {
       "path": "script/platforms/nodejs.js",
@@ -58,6 +65,10 @@
     {
       "path": "script/platforms/cloudflare.js",
       "limit": "10 KB"
+    },
+    {
+      "path": "script/platforms/node_with_fetch.js",
+      "limit": "15 KB"
     }
   ],
   "exports": {

package/script/pkg/commands/script_exists.js

@@ -8,16 +8,7 @@ const command_js_1 = require("./command.js");
 class ScriptExistsCommand extends command_js_1.Command {
     constructor(hashes, opts) {
         super(["script", "exists", ...hashes], {
-            deserialize: (result) => {
-                /**
-                 * This isn't very pretty but it does the job.
-                 * The user facing api is clean and will return a single `string` if they provided
-                 * a single script hash, and an array of strings of the same length when given an
-                 * array of hashes.
-                 */
-                const parsed = result;
-                return parsed.length === 1 ? parsed[0] : parsed;
-            },
+            deserialize: (result) => result,
             ...opts,
         });
     }

package/script/pkg/http.js

@@ -22,14 +22,30 @@ class HttpClient {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "retry", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.baseUrl = config.baseUrl.replace(/\/$/, "");
         this.headers = { "Content-Type": "application/json", ...config.headers };
-        this.options = config.options;
+        this.options = { backend: config.options?.backend };
+        if (typeof config?.retry === "boolean" && config?.retry === false) {
+            this.retry = {
+                attempts: 1,
+                backoff: () => 0,
+            };
+        }
+        else {
+            this.retry = {
+                attempts: config?.retry?.retries ?? 5,
+                backoff: config?.retry?.backoff ??
+                    ((retryCount) => Math.exp(retryCount) * 50),
+            };
+        }
     }
     async request(req) {
-        if (!req.path) {
-            req.path = [];
-        }
         const requestOptions = {
             method: "POST",
             headers: this.headers,
@@ -40,9 +56,21 @@ class HttpClient {
              */
             backend: this.options?.backend,
         };
-        // fetch is defined by isomorphic fetch
-        // eslint-disable-next-line no-undef
-        const res = await fetch([this.baseUrl, ...req.path].join("/"), requestOptions);
+        let res = null;
+        let error = null;
+        for (let i = 0; i <= this.retry.attempts; i++) {
+            try {
+                res = await fetch([this.baseUrl, ...(req.path ?? [])].join("/"), requestOptions);
+                break;
+            }
+            catch (err) {
+                error = err;
+                await new Promise((r) => setTimeout(r, this.retry.backoff(i)));
+            }
+        }
+        if (!res) {
+            throw error ?? new Error("Exhausted all retries");
+        }
         const body = (await res.json());
         if (!res.ok) {
             throw new error_js_1.UpstashError(body.error);

package/script/platforms/cloudflare.js

@@ -25,7 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Redis = void 0;
 const core = __importStar(require("../pkg/redis.js"));
-const error_js_1 = require("../pkg/error.js");
+const http_js_1 = require("../pkg/http.js");
 /**
  * Serverless redis client for upstash.
  */
@@ -52,7 +52,8 @@ class Redis extends core.Redis {
             /\r|\n/.test(config.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
-        const client = defaultRequester({
+        const client = new http_js_1.HttpClient({
+            retry: config.retry,
             baseUrl: config.url,
             headers: { authorization: `Bearer ${config.token}` },
         });
@@ -70,9 +71,8 @@ class Redis extends core.Redis {
      * ```ts
      * const redis = Redis.fromEnv(env)
      * ```
-     *
      */
-    static fromEnv(env) {
+    static fromEnv(env, opts) {
         // @ts-ignore These will be defined by cloudflare
         const url = env?.UPSTASH_REDIS_REST_URL ?? UPSTASH_REDIS_REST_URL;
         // @ts-ignore These will be defined by cloudflare
@@ -83,27 +83,7 @@ class Redis extends core.Redis {
         if (!token) {
             throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`. Please add it via `wrangler secret put UPSTASH_REDIS_REST_TOKEN`");
         }
-        return new Redis({ url, token });
+        return new Redis({ ...opts, url, token });
     }
 }
 exports.Redis = Redis;
-function defaultRequester(config) {
-    return {
-        request: async function (req) {
-            if (!req.path) {
-                req.path = [];
-            }
-            const res = await fetch([config.baseUrl, ...req.path].join("/"), {
-                method: "POST",
-                headers: { "Content-Type": "application/json", ...config.headers },
-                body: JSON.stringify(req.body),
-                keepalive: true,
-            });
-            const body = (await res.json());
-            if (!res.ok) {
-                throw new error_js_1.UpstashError(body.error);
-            }
-            return body;
-        },
-    };
-}

package/script/platforms/fastly.js

@@ -25,7 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Redis = void 0;
 const core = __importStar(require("../pkg/redis.js"));
-const error_js_1 = require("../pkg/error.js");
+const http_js_1 = require("../pkg/http.js");
 /**
  * Serverless redis client for upstash.
  */
@@ -53,10 +53,11 @@ class Redis extends core.Redis {
             /\r|\n/.test(config.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
-        const client = defaultRequester({
+        const client = new http_js_1.HttpClient({
             baseUrl: config.url,
+            retry: config.retry,
             headers: { authorization: `Bearer ${config.token}` },
-            backend: config.backend,
+            options: { backend: config.backend },
         });
         super(client, {
             automaticDeserialization: config.automaticDeserialization,
@@ -64,25 +65,3 @@ class Redis extends core.Redis {
     }
 }
 exports.Redis = Redis;
-function defaultRequester(config) {
-    return {
-        request: async function (req) {
-            if (!req.path) {
-                req.path = [];
-            }
-            const res = await fetch([config.baseUrl, ...req.path].join("/"), {
-                method: "POST",
-                headers: { "Content-Type": "application/json", ...config.headers },
-                body: JSON.stringify(req.body),
-                keepalive: true,
-                // @ts-expect-error fastly requires `backend`
-                backend: config.backend,
-            });
-            const body = (await res.json());
-            if (!res.ok) {
-                throw new error_js_1.UpstashError(body.error);
-            }
-            return body;
-        },
-    };
-}

package/script/platforms/node_with_fetch.js

@@ -26,7 +26,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Redis = void 0;
 const core = __importStar(require("../pkg/redis.js"));
-const error_js_1 = require("../pkg/error.js");
+const http_js_1 = require("../pkg/http.js");
 require("isomorphic-fetch");
 /**
  * Serverless redis client for upstash.
@@ -47,8 +47,9 @@ class Redis extends core.Redis {
             /\r|\n/.test(configOrRequester.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
-        const client = defaultRequester({
+        const client = new http_js_1.HttpClient({
             baseUrl: configOrRequester.url,
+            retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
             // agent: configOrRequester.agent,
         });
@@ -80,29 +81,7 @@ class Redis extends core.Redis {
         if (!token) {
             throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`");
         }
-        return new Redis({ url, token, ...config });
+        return new Redis({ ...config, url, token });
     }
 }
 exports.Redis = Redis;
-function defaultRequester(config) {
-    return {
-        request: async function (req) {
-            if (!req.path) {
-                req.path = [];
-            }
-            const res = await fetch([config.baseUrl, ...req.path].join("/"), {
-                method: "POST",
-                headers: { "Content-Type": "application/json", ...config.headers },
-                body: JSON.stringify(req.body),
-                keepalive: true,
-                // @ts-ignore
-                agent: config.agent,
-            });
-            const body = (await res.json());
-            if (!res.ok) {
-                throw new error_js_1.UpstashError(body.error);
-            }
-            return body;
-        },
-    };
-}

package/script/platforms/nodejs.js

@@ -26,7 +26,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Redis = void 0;
 const core = __importStar(require("../pkg/redis.js"));
-const error_js_1 = require("../pkg/error.js");
+const http_js_1 = require("../pkg/http.js");
 /**
  * Serverless redis client for upstash.
  */
@@ -46,8 +46,9 @@ class Redis extends core.Redis {
             /\r|\n/.test(configOrRequester.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
-        const client = defaultRequester({
+        const client = new http_js_1.HttpClient({
             baseUrl: configOrRequester.url,
+            retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
             // agent: configOrRequester.agent,
         });
@@ -79,29 +80,7 @@ class Redis extends core.Redis {
         if (!token) {
             throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`");
         }
-        return new Redis({ url, token, ...config });
+        return new Redis({ ...config, url, token });
     }
 }
 exports.Redis = Redis;
-function defaultRequester(config) {
-    return {
-        request: async function (req) {
-            if (!req.path) {
-                req.path = [];
-            }
-            const res = await fetch([config.baseUrl, ...req.path].join("/"), {
-                method: "POST",
-                headers: { "Content-Type": "application/json", ...config.headers },
-                body: JSON.stringify(req.body),
-                keepalive: true,
-                // @ts-ignore
-                agent: config.agent,
-            });
-            const body = (await res.json());
-            if (!res.ok) {
-                throw new error_js_1.UpstashError(body.error);
-            }
-            return body;
-        },
-    };
-}

package/types/pkg/commands/hmset.d.ts

@@ -2,8 +2,8 @@ import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/hmset
  */
-export declare class HMSetCommand<TData> extends Command<number, number> {
+export declare class HMSetCommand<TData> extends Command<"OK", "OK"> {
     constructor([key, kv]: [key: string, kv: {
         [field: string]: TData;
-    }], opts?: CommandOptions<number, number>);
+    }], opts?: CommandOptions<"OK", "OK">);
 }

package/types/pkg/commands/script_exists.d.ts

@@ -1,9 +1,7 @@
 import { Command, CommandOptions } from "./command.js";
-declare type TupleOfLength<T, L extends number, R extends T[] = []> = R["length"] extends L ? R : TupleOfLength<T, L, [...R, T]>;
 /**
  * @see https://redis.io/commands/script-exists
  */
-export declare class ScriptExistsCommand<T extends [string, ...string[]]> extends Command<T extends [string] ? string : TupleOfLength<string, T["length"]>, TupleOfLength<string, T["length"]>> {
-    constructor(hashes: T, opts?: CommandOptions<T extends [string] ? string : TupleOfLength<string, T["length"]>, TupleOfLength<string, T["length"]>>);
+export declare class ScriptExistsCommand<T extends string[]> extends Command<string[], number[]> {
+    constructor(hashes: T, opts?: CommandOptions<string[], number[]>);
 }
-export {};

package/types/pkg/commands/sinterstore.d.ts

@@ -2,6 +2,6 @@ import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/sinterstore
  */
-export declare class SInterStoreCommand<TData = string> extends Command<unknown[], TData[]> {
-    constructor(cmd: [destination: string, key: string, ...keys: string[]], opts?: CommandOptions<unknown[], TData[]>);
+export declare class SInterStoreCommand extends Command<number, number> {
+    constructor(cmd: [destination: string, key: string, ...keys: string[]], opts?: CommandOptions<number, number>);
 }

package/types/pkg/commands/spop.d.ts

@@ -2,6 +2,6 @@ import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/spop
  */
-export declare class SPopCommand<TData = number> extends Command<string | null, TData | null> {
+export declare class SPopCommand<TData> extends Command<string | null, TData | null> {
     constructor([key, count]: [key: string, count?: number], opts?: CommandOptions<string | null, TData | null>);
 }

package/types/pkg/http.d.ts

@@ -12,12 +12,31 @@ export declare type UpstashResponse<TResult> = {
 export interface Requester {
     request: <TResult = unknown>(req: UpstashRequest) => Promise<UpstashResponse<TResult>>;
 }
+export declare type RetryConfig = false | {
+    /**
+     * The number of retries to attempt before giving up.
+     *
+     * @default 5
+     */
+    retries?: number;
+    /**
+     * A backoff function receives the current retry cound and returns a number in milliseconds to wait before retrying.
+     *
+     * @default
+     * ```ts
+     * Math.exp(retryCount) * 50
+     * ```
+     */
+    backoff?: (retryCount: number) => number;
+};
+declare type Options = {
+    backend?: string;
+};
 export declare type HttpClientConfig = {
     headers?: Record<string, string>;
     baseUrl: string;
-    options?: {
-        backend?: string;
-    };
+    options?: Options;
+    retry?: RetryConfig;
 };
 export declare class HttpClient implements Requester {
     baseUrl: string;
@@ -25,6 +44,11 @@ export declare class HttpClient implements Requester {
     readonly options?: {
         backend?: string;
     };
+    readonly retry: {
+        attempts: number;
+        backoff: (retryCount: number) => number;
+    };
     constructor(config: HttpClientConfig);
     request<TResult>(req: UpstashRequest): Promise<UpstashResponse<TResult>>;
 }
+export {};

package/types/pkg/pipeline.d.ts

@@ -1,4 +1,4 @@
-import { DelCommand, ExistsCommand, FlushAllCommand, PingCommand, ScoreMember, SetCommandOptions, TouchCommand, UnlinkCommand, ZAddCommandOptions, ZAddCommandOptionsWithIncr, ZRangeCommandOptions } from "./commands/mod.js";
+import { DelCommand, ExistsCommand, FlushAllCommand, PingCommand, ScoreMember, ScriptExistsCommand, SetCommandOptions, TouchCommand, UnlinkCommand, ZAddCommandOptions, ZAddCommandOptionsWithIncr, ZRangeCommandOptions } from "./commands/mod.js";
 import { CommandOptions } from "./commands/command.js";
 import { Requester } from "./http.js";
 import { CommandArgs } from "./types.js";
@@ -349,7 +349,7 @@ export declare class Pipeline {
     /**
      * @see https://redis.io/commands/script-exists
      */
-    scriptExists: (args_0: string, ...args_1: string[]) => this;
+    scriptExists: (...args: CommandArgs<typeof ScriptExistsCommand>) => this;
     /**
      * @see https://redis.io/commands/script-flush
      */

package/types/pkg/redis.d.ts

@@ -1,4 +1,4 @@
-import { CommandOptions, DelCommand, ExistsCommand, FlushAllCommand, PingCommand, ScoreMember, SetCommandOptions, TouchCommand, UnlinkCommand, ZAddCommandOptions, ZAddCommandOptionsWithIncr, ZRangeCommandOptions } from "./commands/mod.js";
+import { CommandOptions, DelCommand, ExistsCommand, FlushAllCommand, PingCommand, ScoreMember, ScriptExistsCommand, SetCommandOptions, TouchCommand, UnlinkCommand, ZAddCommandOptions, ZAddCommandOptionsWithIncr, ZRangeCommandOptions } from "./commands/mod.js";
 import { Requester } from "./http.js";
 import { Pipeline } from "./pipeline.js";
 import type { CommandArgs } from "./types.js";
@@ -160,7 +160,7 @@ export declare class Redis {
      */
     hmset: <TData>(key: string, kv: {
         [field: string]: TData;
-    }) => Promise<number>;
+    }) => Promise<"OK">;
     /**
      * @see https://redis.io/commands/hscan
      */
@@ -322,7 +322,7 @@ export declare class Redis {
     /**
      * @see https://redis.io/commands/script-exists
      */
-    scriptExists: (args_0: string, ...args_1: string[]) => Promise<[]>;
+    scriptExists: (...args: CommandArgs<typeof ScriptExistsCommand>) => Promise<number[]>;
     /**
      * @see https://redis.io/commands/script-flush
      */
@@ -366,7 +366,7 @@ export declare class Redis {
     /**
      * @see https://redis.io/commands/sinterstore
      */
-    sinterstore: (destination: string, key: string, ...keys: string[]) => Promise<string[]>;
+    sinterstore: (destination: string, key: string, ...keys: string[]) => Promise<number>;
     /**
      * @see https://redis.io/commands/sismember
      */

package/types/platforms/cloudflare.d.ts

@@ -1,5 +1,5 @@
 import * as core from "../pkg/redis.js";
-import type { Requester, UpstashRequest, UpstashResponse } from "../pkg/http.js";
+import type { Requester, RetryConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
 export type { Requester, UpstashRequest, UpstashResponse };
 /**
  * Connection credentials for upstash redis.
@@ -14,6 +14,10 @@ export declare type RedisConfigCloudflare = {
      * UPSTASH_REDIS_REST_TOKEN
      */
     token: string;
+    /**
+     * Configure the retry behaviour in case of network errors
+     */
+    retry?: RetryConfig;
 } & core.RedisOptions;
 /**
  * Serverless redis client for upstash.
@@ -34,5 +38,5 @@ export declare class Redis extends core.Redis {
     static fromEnv(env?: {
         UPSTASH_REDIS_REST_URL: string;
         UPSTASH_REDIS_REST_TOKEN: string;
-    }): Redis;
+    }, opts?: Omit<RedisConfigCloudflare, "url" | "token">): Redis;
 }

package/types/platforms/fastly.d.ts

@@ -1,5 +1,5 @@
 import * as core from "../pkg/redis.js";
-import type { Requester, UpstashRequest, UpstashResponse } from "../pkg/http.js";
+import type { Requester, RetryConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
 export type { Requester, UpstashRequest, UpstashResponse };
 /**
  * Connection credentials for upstash redis.
@@ -20,6 +20,10 @@ export declare type RedisConfigFastly = {
      * referenced by name.
      */
     backend: string;
+    /**
+     * Configure the retry behaviour in case of network errors
+     */
+    retry?: RetryConfig;
 } & core.RedisOptions;
 /**
  * Serverless redis client for upstash.

package/types/platforms/node_with_fetch.d.ts

@@ -1,5 +1,5 @@
 import * as core from "../pkg/redis.js";
-import { Requester, UpstashRequest, UpstashResponse } from "../pkg/http.js";
+import { Requester, RetryConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
 import "isomorphic-fetch";
 export type { Requester, UpstashRequest, UpstashResponse };
 /**
@@ -15,6 +15,25 @@ export declare type RedisConfigNodejs = {
      * UPSTASH_REDIS_REST_TOKEN
      */
     token: string;
+    /**
+     * An agent allows you to reuse connections to reduce latency for multiple sequential requests.
+     *
+     * This is a node specific implementation and is not supported in various runtimes like Vercel
+     * edge functions.
+     *
+     * @example
+     * ```ts
+     * import https from "https"
+     *
+     * const options: RedisConfigNodejs = {
+     *  agent: new https.Agent({ keepAlive: true })
+     * }
+     * ```
+     */
+    /**
+     * Configure the retry behaviour in case of network errors
+     */
+    retry?: RetryConfig;
 } & core.RedisOptions;
 /**
  * Serverless redis client for upstash.

package/types/platforms/nodejs.d.ts

@@ -1,5 +1,5 @@
 import * as core from "../pkg/redis.js";
-import { Requester, UpstashRequest, UpstashResponse } from "../pkg/http.js";
+import { Requester, RetryConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
 export type { Requester, UpstashRequest, UpstashResponse };
 /**
  * Connection credentials for upstash redis.
@@ -14,6 +14,25 @@ export declare type RedisConfigNodejs = {
      * UPSTASH_REDIS_REST_TOKEN
      */
     token: string;
+    /**
+     * An agent allows you to reuse connections to reduce latency for multiple sequential requests.
+     *
+     * This is a node specific implementation and is not supported in various runtimes like Vercel
+     * edge functions.
+     *
+     * @example
+     * ```ts
+     * import https from "https"
+     *
+     * const options: RedisConfigNodejs = {
+     *  agent: new https.Agent({ keepAlive: true })
+     * }
+     * ```
+     */
+    /**
+     * Configure the retry behaviour in case of network errors
+     */
+    retry?: RetryConfig;
 } & core.RedisOptions;
 /**
  * Serverless redis client for upstash.