@upstash/redis 0.0.0-ci.bf3f49d1 → 0.0.0-ci.c37cc01e

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, ScriptExistsCommand, SetCommandOptions, TouchCommand, UnlinkCommand, ZAddCommandOptions, ZAddCommandOptionsWithIncr, ZRangeCommandOptions } from "./commands/mod.js";
+import { DelCommand, ExistsCommand, FlushAllCommand, MGetCommand, 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";
@@ -79,7 +79,7 @@ export declare class Pipeline {
     /**
      * @see https://redis.io/commands/bitpos
      */
-    bitpos: (key: string, start: number, end: number) => this;
+    bitpos: (key: string, bit: 0 | 1, start?: number | undefined, end?: number | undefined) => this;
     /**
      * @see https://redis.io/commands/dbsize
      */
@@ -241,7 +241,15 @@ export declare class Pipeline {
     /**
      * @see https://redis.io/commands/lpop
      */
-    lpop: <TData>(key: string) => this;
+    lpop: <TData>(key: string, count?: number | undefined) => this;
+    /**
+     * @see https://redis.io/commands/lpos
+     */
+    lpos: <TData>(key: string, element: unknown, opts?: {
+        rank?: number | undefined;
+        count?: number | undefined;
+        maxLen?: number | undefined;
+    } | undefined) => this;
     /**
      * @see https://redis.io/commands/lpush
      */
@@ -269,7 +277,7 @@ export declare class Pipeline {
     /**
      * @see https://redis.io/commands/mget
      */
-    mget: <TData extends unknown[]>(args_0: string, ...args_1: string[]) => this;
+    mget: <TData extends unknown[]>(...args: CommandArgs<typeof MGetCommand>) => this;
     /**
      * @see https://redis.io/commands/mset
      */
@@ -325,7 +333,7 @@ export declare class Pipeline {
     /**
      * @see https://redis.io/commands/rpop
      */
-    rpop: <TData = string>(key: string) => this;
+    rpop: <TData = string>(key: string, count?: number | undefined) => this;
     /**
      * @see https://redis.io/commands/rpush
      */

package/types/pkg/redis.d.ts

@@ -1,5 +1,5 @@
-import { CommandOptions, DelCommand, ExistsCommand, FlushAllCommand, PingCommand, ScoreMember, ScriptExistsCommand, SetCommandOptions, TouchCommand, UnlinkCommand, ZAddCommandOptions, ZAddCommandOptionsWithIncr, ZRangeCommandOptions } from "./commands/mod.js";
-import { Requester } from "./http.js";
+import { CommandOptions, DelCommand, ExistsCommand, FlushAllCommand, MGetCommand, PingCommand, ScoreMember, ScriptExistsCommand, SetCommandOptions, TouchCommand, UnlinkCommand, ZAddCommandOptions, ZAddCommandOptionsWithIncr, ZRangeCommandOptions } from "./commands/mod.js";
+import { Requester, UpstashRequest, UpstashResponse } from "./http.js";
 import { Pipeline } from "./pipeline.js";
 import type { CommandArgs } from "./types.js";
 export declare type RedisOptions = {
@@ -14,7 +14,7 @@ export declare type RedisOptions = {
  * Serverless redis client for upstash.
  */
 export declare class Redis {
-    protected readonly client: Requester;
+    protected client: Requester;
     protected opts?: CommandOptions<any, any>;
     /**
      * Create a new redis client
@@ -28,6 +28,10 @@ export declare class Redis {
      * ```
      */
     constructor(client: Requester, opts?: RedisOptions);
+    /**
+     * Wrap a new middleware around the HTTP client.
+     */
+    use: <TResult = unknown>(middleware: (r: UpstashRequest, next: <TResult_1 = unknown>(req: UpstashRequest) => Promise<UpstashResponse<TResult_1>>) => Promise<UpstashResponse<TResult>>) => void;
     /**
      * Create a new pipeline that allows you to send requests in bulk.
      *
@@ -52,7 +56,7 @@ export declare class Redis {
     /**
      * @see https://redis.io/commands/bitpos
      */
-    bitpos: (key: string, start: number, end: number) => Promise<number>;
+    bitpos: (key: string, bit: 0 | 1, start?: number | undefined, end?: number | undefined) => Promise<number>;
     /**
      * @see https://redis.io/commands/dbsize
      */
@@ -214,7 +218,15 @@ export declare class Redis {
     /**
      * @see https://redis.io/commands/lpop
      */
-    lpop: <TData>(key: string) => Promise<TData | null>;
+    lpop: <TData>(key: string, count?: number | undefined) => Promise<TData | null>;
+    /**
+     * @see https://redis.io/commands/lpos
+     */
+    lpos: <TData = number>(key: string, element: unknown, opts?: {
+        rank?: number | undefined;
+        count?: number | undefined;
+        maxLen?: number | undefined;
+    } | undefined) => Promise<TData>;
     /**
      * @see https://redis.io/commands/lpush
      */
@@ -242,7 +254,7 @@ export declare class Redis {
     /**
      * @see https://redis.io/commands/mget
      */
-    mget: <TData extends unknown[]>(args_0: string, ...args_1: string[]) => Promise<TData>;
+    mget: <TData extends unknown[]>(...args: CommandArgs<typeof MGetCommand>) => Promise<TData>;
     /**
      * @see https://redis.io/commands/mset
      */
@@ -298,7 +310,7 @@ export declare class Redis {
     /**
      * @see https://redis.io/commands/rpop
      */
-    rpop: <TData = string>(key: string) => Promise<TData | null>;
+    rpop: <TData = string>(key: string, count?: number | undefined) => Promise<TData | null>;
     /**
      * @see https://redis.io/commands/rpush
      */

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.