@upstash/redis 1.3.2-alpha.2 → 1.3.3-alpha.0

package/script/platforms/cloudflare.js

@@ -46,7 +46,9 @@ class Redis extends core.Redis {
             baseUrl: config.url,
             headers: { authorization: `Bearer ${config.token}` },
         });
-        super(client);
+        super(client, {
+            automaticDeserialization: config.automaticDeserialization,
+        });
     }
     /*
      * Create a new Upstash Redis instance from environment variables on cloudflare.

package/script/platforms/fastly.js

@@ -48,7 +48,9 @@ class Redis extends core.Redis {
             headers: { authorization: `Bearer ${config.token}` },
             backend: config.backend,
         });
-        super(client);
+        super(client, {
+            automaticDeserialization: config.automaticDeserialization,
+        });
     }
 }
 exports.Redis = Redis;

package/script/platforms/nodejs.js

@@ -42,7 +42,9 @@ class Redis extends core.Redis {
             headers: { authorization: `Bearer ${configOrRequester.token}` },
             agent: configOrRequester.agent,
         });
-        super(client);
+        super(client, {
+            automaticDeserialization: configOrRequester.automaticDeserialization,
+        });
     }
     /**
      * Create a new Upstash Redis instance from environment variables.

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/append
  */
 export declare class AppendCommand extends Command<number, number> {
-    constructor(key: string, value: string);
+    constructor(cmd: [key: string, value: string], opts?: CommandOptions<number, number>);
 }

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

@@ -1,8 +1,8 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/bitcount
  */
 export declare class BitCountCommand extends Command<number, number> {
-    constructor(key: string, start?: never, end?: never);
-    constructor(key: string, start: number, end: number);
+    constructor(cmd: [key: string, start?: never, end?: never], opts?: CommandOptions<number, number>);
+    constructor(cmd: [key: string, start: number, end: number], opts?: CommandOptions<number, number>);
 }

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

@@ -1,8 +1,13 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/bitop
  */
 export declare class BitOpCommand extends Command<number, number> {
-    constructor(op: "and" | "or" | "xor", destinationKey: string, sourceKey: string, ...sourceKeys: string[]);
-    constructor(op: "not", destinationKey: string, sourceKey: string);
+    constructor(cmd: [
+        op: "and" | "or" | "xor",
+        destinationKey: string,
+        sourceKey: string,
+        ...sourceKeys: string[]
+    ], opts?: CommandOptions<number, number>);
+    constructor(cmd: [op: "not", destinationKey: string, sourceKey: string], opts?: CommandOptions<number, number>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/bitpos
  */
 export declare class BitPosCommand extends Command<number, number> {
-    constructor(key: string, start: number, end: number);
+    constructor(cmd: [key: string, start: number, end: number], opts?: CommandOptions<number, number>);
 }

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

@@ -1,23 +1,37 @@
 import { Requester } from "../http.js";
+declare type Serialize = (data: unknown) => string;
+declare type Deserialize<TResult, TData> = (result: TResult) => TData;
+export declare type CommandOptions<TResult, TData> = {
+    /**
+     * Custom deserializer
+     */
+    deserialize?: (result: TResult) => TData;
+    /**
+     * Automatically try to deserialize the returned data from upstash using `JSON.deserialize`
+     *
+     * @default true
+     */
+    automaticDeserialization?: boolean;
+};
 /**
  * Command offers default (de)serialization and the exec method to all commands.
  *
  * 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.
  */
-export declare class Command<TData, TResult> {
+export declare class Command<TResult, TData> {
     readonly command: string[];
-    deserialize: (result: TResult) => TData;
+    readonly serialize: Serialize;
+    readonly deserialize: Deserialize<TResult, TData>;
     /**
      * Create a new command instance.
      *
      * You can define a custom `deserialize` function. By default we try to deserialize as json.
      */
-    constructor(command: (string | unknown)[], opts?: {
-        deserialize?: (result: TResult) => TData;
-    });
+    constructor(command: (string | unknown)[], opts?: CommandOptions<TResult, TData>);
     /**
      * Execute the command using a client.
      */
     exec(client: Requester): Promise<TData>;
 }
+export {};

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/dbsize
  */
 export declare class DBSizeCommand extends Command<number, number> {
-    constructor();
+    constructor(opts?: CommandOptions<number, number>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/decr
  */
 export declare class DecrCommand extends Command<number, number> {
-    constructor(key: string);
+    constructor(cmd: [key: string], opts?: CommandOptions<number, number>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/decrby
  */
 export declare class DecrByCommand extends Command<number, number> {
-    constructor(key: string, decrement: number);
+    constructor(cmd: [key: string, decrement: number], opts?: CommandOptions<number, number>);
 }

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

@@ -1,8 +1,7 @@
-import { NonEmptyArray } from "../types.js";
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/del
  */
 export declare class DelCommand extends Command<number, number> {
-    constructor(...keys: NonEmptyArray<string>);
+    constructor(cmd: [...keys: string[]], opts?: CommandOptions<number, number>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/echo
  */
 export declare class EchoCommand extends Command<string, string> {
-    constructor(message: string);
+    constructor(cmd: [message: string], opts?: CommandOptions<string, string>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/eval
  */
 export declare class EvalCommand<TArgs extends unknown[], TData> extends Command<unknown, TData> {
-    constructor(script: string, keys: string[], args: TArgs);
+    constructor([script, keys, args]: [script: string, keys: string[], args: TArgs], opts?: CommandOptions<unknown, TData>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/evalsha
  */
 export declare class EvalshaCommand<TArgs extends unknown[], TData> extends Command<unknown, TData> {
-    constructor(sha: string, keys: string[], args?: TArgs);
+    constructor([sha, keys, args]: [sha: string, keys: string[], args?: TArgs], opts?: CommandOptions<unknown, TData>);
 }

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

@@ -1,8 +1,7 @@
-import { NonEmptyArray } from "../types.js";
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/exists
  */
 export declare class ExistsCommand extends Command<number, number> {
-    constructor(...keys: NonEmptyArray<string>);
+    constructor(cmd: [...keys: string[]], opts?: CommandOptions<number, number>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/expire
  */
-export declare class ExpireCommand extends Command<0 | 1, "0" | "1"> {
-    constructor(key: string, seconds: number);
+export declare class ExpireCommand extends Command<"0" | "1", 0 | 1> {
+    constructor(cmd: [key: string, seconds: number], opts?: CommandOptions<"0" | "1", 0 | 1>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/expireat
  */
-export declare class ExpireAtCommand extends Command<0 | 1, "0" | "1"> {
-    constructor(key: string, unix: number);
+export declare class ExpireAtCommand extends Command<"0" | "1", 0 | 1> {
+    constructor(cmd: [key: string, unix: number], opts?: CommandOptions<"0" | "1", 0 | 1>);
 }

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

@@ -1,9 +1,9 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/flushall
  */
 export declare class FlushAllCommand extends Command<"OK", "OK"> {
-    constructor(opts?: {
+    constructor(args?: [{
         async?: boolean;
-    });
+    }], opts?: CommandOptions<"OK", "OK">);
 }

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

@@ -1,9 +1,9 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/flushdb
  */
 export declare class FlushDBCommand extends Command<"OK", "OK"> {
-    constructor(opts?: {
+    constructor([opts]: [opts?: {
         async?: boolean;
-    });
+    }], cmdOpts?: CommandOptions<"OK", "OK">);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/get
  */
-export declare class GetCommand<TData = string> extends Command<TData | null, unknown | null> {
-    constructor(key: string);
+export declare class GetCommand<TData = string> extends Command<unknown | null, TData | null> {
+    constructor(cmd: [key: string], opts?: CommandOptions<unknown | null, TData | null>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/getbit
  */
-export declare class GetBitCommand extends Command<0 | 1, "0" | "1"> {
-    constructor(key: string, offset: number);
+export declare class GetBitCommand extends Command<"0" | "1", 0 | 1> {
+    constructor(cmd: [key: string, offset: number], opts?: CommandOptions<"0" | "1", 0 | 1>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/getrange
  */
 export declare class GetRangeCommand extends Command<string, string> {
-    constructor(key: string, start: number, end: number);
+    constructor(cmd: [key: string, start: number, end: number], opts?: CommandOptions<string, string>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/getset
  */
-export declare class GetSetCommand<TData = string> extends Command<TData | null, unknown | null> {
-    constructor(key: string, value: TData);
+export declare class GetSetCommand<TData = string> extends Command<unknown | null, TData | null> {
+    constructor(cmd: [key: string, value: TData], opts?: CommandOptions<unknown | null, TData | null>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/hdel
  */
-export declare class HDelCommand extends Command<0 | 1, "0" | "1"> {
-    constructor(key: string, field: string);
+export declare class HDelCommand extends Command<"0" | "1", 0 | 1> {
+    constructor(cmd: [key: string, field: string], opts?: CommandOptions<"0" | "1", 0 | 1>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/hexists
  */
 export declare class HExistsCommand extends Command<number, number> {
-    constructor(key: string, field: string);
+    constructor(cmd: [key: string, field: string], opts?: CommandOptions<number, number>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/hget
  */
-export declare class HGetCommand<TData> extends Command<TData | null, unknown | null> {
-    constructor(key: string, field: string);
+export declare class HGetCommand<TData> extends Command<unknown | null, TData | null> {
+    constructor(cmd: [key: string, field: string], opts?: CommandOptions<unknown | null, TData | null>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/hgetall
  */
-export declare class HGetAllCommand<TData extends Record<string, unknown>> extends Command<TData | null, unknown | null> {
-    constructor(key: string);
+export declare class HGetAllCommand<TData extends Record<string, unknown>> extends Command<unknown | null, TData | null> {
+    constructor(cmd: [key: string], opts?: CommandOptions<unknown | null, TData | null>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/hincrby
  */
 export declare class HIncrByCommand extends Command<number, number> {
-    constructor(key: string, field: string, increment: number);
+    constructor(cmd: [key: string, field: string, increment: number], opts?: CommandOptions<number, number>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/hincrbyfloat
  */
 export declare class HIncrByFloatCommand extends Command<number, number> {
-    constructor(key: string, field: string, increment: number);
+    constructor(cmd: [key: string, field: string, increment: number], opts?: CommandOptions<number, number>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/hkeys
  */
 export declare class HKeysCommand extends Command<string[], string[]> {
-    constructor(key: string);
+    constructor([key]: [key: string], opts?: CommandOptions<string[], string[]>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/hlen
  */
 export declare class HLenCommand extends Command<number, number> {
-    constructor(key: string);
+    constructor(cmd: [key: string], opts?: CommandOptions<number, number>);
 }

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

@@ -1,4 +1,4 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * hmget returns an object of all requested fields from a hash
  * The field values are returned as an object like this:
@@ -10,6 +10,6 @@ import { Command } from "./command.js";
  *
  * @see https://redis.io/commands/hmget
  */
-export declare class HMGetCommand<TData extends Record<string, unknown>> extends Command<TData | null, (string | null)[]> {
-    constructor(key: string, ...fields: string[]);
+export declare class HMGetCommand<TData extends Record<string, unknown>> extends Command<(string | null)[], TData | null> {
+    constructor([key, ...fields]: [key: string, ...fields: string[]], opts?: CommandOptions<(string | null)[], TData | null>);
 }

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

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

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

@@ -1,5 +1,5 @@
 import { ScanCommandOptions } from "./scan.js";
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/hscan
  */
@@ -10,5 +10,15 @@ export declare class HScanCommand extends Command<[
     number,
     (string | number)[]
 ]> {
-    constructor(key: string, cursor: number, opts?: ScanCommandOptions);
+    constructor([key, cursor, cmdOpts]: [
+        key: string,
+        cursor: number,
+        cmdOpts?: ScanCommandOptions
+    ], opts?: CommandOptions<[
+        number,
+        (string | number)[]
+    ], [
+        number,
+        (string | number)[]
+    ]>);
 }

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

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

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/hsetnx
  */
-export declare class HSetNXCommand<TData> extends Command<0 | 1, "0" | "1"> {
-    constructor(key: string, field: string, value: TData);
+export declare class HSetNXCommand<TData> extends Command<"0" | "1", 0 | 1> {
+    constructor(cmd: [key: string, field: string, value: TData], opts?: CommandOptions<"0" | "1", 0 | 1>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/hstrlen
  */
 export declare class HStrLenCommand extends Command<number, number> {
-    constructor(key: string, field: string);
+    constructor(cmd: [key: string, field: string], opts?: CommandOptions<number, number>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/hvals
  */
-export declare class HValsCommand<TData extends unknown[]> extends Command<TData, unknown[]> {
-    constructor(key: string);
+export declare class HValsCommand<TData extends unknown[]> extends Command<unknown[], TData> {
+    constructor(cmd: [key: string], opts?: CommandOptions<unknown[], TData>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/incr
  */
 export declare class IncrCommand extends Command<number, number> {
-    constructor(key: string);
+    constructor(cmd: [key: string], opts?: CommandOptions<number, number>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/incrby
  */
 export declare class IncrByCommand extends Command<number, number> {
-    constructor(key: string, value: number);
+    constructor(cmd: [key: string, value: number], opts?: CommandOptions<number, number>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/incrbyfloat
  */
 export declare class IncrByFloatCommand extends Command<number, number> {
-    constructor(key: string, value: number);
+    constructor(cmd: [key: string, value: number], opts?: CommandOptions<number, number>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/keys
  */
 export declare class KeysCommand extends Command<string[], string[]> {
-    constructor(pattern: string);
+    constructor(cmd: [pattern: string], opts?: CommandOptions<string[], string[]>);
 }

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

@@ -1,4 +1,4 @@
-import { Command } from "./command.js";
-export declare class LIndexCommand<TData = string> extends Command<TData | null, unknown | null> {
-    constructor(key: string, index: number);
+import { Command, CommandOptions } from "./command.js";
+export declare class LIndexCommand<TData = string> extends Command<unknown | null, TData | null> {
+    constructor(cmd: [key: string, index: number], opts?: CommandOptions<unknown | null, TData | null>);
 }

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

@@ -1,4 +1,9 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 export declare class LInsertCommand<TData = string> extends Command<number, number> {
-    constructor(key: string, direction: "before" | "after", pivot: TData, value: TData);
+    constructor(cmd: [
+        key: string,
+        direction: "before" | "after",
+        pivot: TData,
+        value: TData
+    ], opts?: CommandOptions<number, number>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/llen
  */
 export declare class LLenCommand extends Command<number, number> {
-    constructor(key: string);
+    constructor(cmd: [key: string], opts?: CommandOptions<number, number>);
 }

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

@@ -1,7 +1,7 @@
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/lpop
  */
-export declare class LPopCommand<TData = string> extends Command<TData | null, unknown | null> {
-    constructor(key: string);
+export declare class LPopCommand<TData = string> extends Command<unknown | null, TData | null> {
+    constructor(cmd: [key: string], opts?: CommandOptions<unknown | null, TData | null>);
 }

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

@@ -1,8 +1,7 @@
-import { NonEmptyArray } from "../types.js";
-import { Command } from "./command.js";
+import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/lpush
  */
 export declare class LPushCommand<TData = string> extends Command<number, number> {
-    constructor(key: string, ...elements: NonEmptyArray<TData>);
+    constructor(cmd: [key: string, ...elements: TData[]], opts?: CommandOptions<number, number>);
 }