@upstash/redis 1.3.0 → 1.3.2-alpha.1

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

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

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

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

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

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

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

@@ -0,0 +1,15 @@
+import { Command } from "./command.js";
+/**
+ * hmget returns an object of all requested fields from a hash
+ * The field values are returned as an object like this:
+ * ```ts
+ * {[fieldName: string]: T | null}
+ * ```
+ *
+ * In case the hash does not exist or all fields are empty `null` is returned
+ *
+ * @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[]);
+}

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

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

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

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

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

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

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

@@ -0,0 +1,7 @@
+import { Command } 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);
+}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,8 @@
+import { NonEmptyArray } from "../types.js";
+import { Command } 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>);
+}

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

@@ -0,0 +1,8 @@
+import { NonEmptyArray } from "../types.js";
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/lpushx
+ */
+export declare class LPushXCommand<TData> extends Command<number, number> {
+    constructor(key: string, ...elements: NonEmptyArray<TData>);
+}

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

@@ -0,0 +1,4 @@
+import { Command } from "./command.js";
+export declare class LRangeCommand<TData = string> extends Command<TData[], unknown[]> {
+    constructor(key: string, start: number, end: number);
+}

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

@@ -0,0 +1,4 @@
+import { Command } from "./command.js";
+export declare class LRemCommand<TData> extends Command<number, number> {
+    constructor(key: string, count: number, value: TData);
+}

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

@@ -0,0 +1,4 @@
+import { Command } from "./command.js";
+export declare class LSetCommand<TData = string> extends Command<"OK", "OK"> {
+    constructor(key: string, value: TData, index: number);
+}

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

@@ -0,0 +1,4 @@
+import { Command } from "./command.js";
+export declare class LTrimCommand extends Command<"OK", "OK"> {
+    constructor(key: string, start: number, end: number);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/mget
+ */
+export declare class MGetCommand<TData extends unknown[]> extends Command<TData, (string | null)[]> {
+    constructor(...keys: [string, ...string[]]);
+}

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

@@ -0,0 +1,114 @@
+export * from "./append.js";
+export * from "./bitcount.js";
+export * from "./bitop.js";
+export * from "./bitpos.js";
+export * from "./command.js";
+export * from "./dbsize.js";
+export * from "./decr.js";
+export * from "./decrby.js";
+export * from "./del.js";
+export * from "./echo.js";
+export * from "./eval.js";
+export * from "./evalsha.js";
+export * from "./exists.js";
+export * from "./expire.js";
+export * from "./expireat.js";
+export * from "./flushall.js";
+export * from "./flushdb.js";
+export * from "./get.js";
+export * from "./getbit.js";
+export * from "./getrange.js";
+export * from "./getset.js";
+export * from "./hdel.js";
+export * from "./hexists.js";
+export * from "./hget.js";
+export * from "./hgetall.js";
+export * from "./hincrby.js";
+export * from "./hincrbyfloat.js";
+export * from "./hkeys.js";
+export * from "./hlen.js";
+export * from "./hmget.js";
+export * from "./hmset.js";
+export * from "./hscan.js";
+export * from "./hset.js";
+export * from "./hsetnx.js";
+export * from "./hstrlen.js";
+export * from "./hvals.js";
+export * from "./incr.js";
+export * from "./incrby.js";
+export * from "./incrbyfloat.js";
+export * from "./keys.js";
+export * from "./lindex.js";
+export * from "./linsert.js";
+export * from "./llen.js";
+export * from "./lpop.js";
+export * from "./lpush.js";
+export * from "./lpushx.js";
+export * from "./lrange.js";
+export * from "./lrem.js";
+export * from "./lset.js";
+export * from "./ltrim.js";
+export * from "./mget.js";
+export * from "./mset.js";
+export * from "./msetnx.js";
+export * from "./persist.js";
+export * from "./pexpire.js";
+export * from "./pexpireat.js";
+export * from "./ping.js";
+export * from "./psetex.js";
+export * from "./pttl.js";
+export * from "./publish.js";
+export * from "./randomkey.js";
+export * from "./rename.js";
+export * from "./renamenx.js";
+export * from "./rpop.js";
+export * from "./rpush.js";
+export * from "./rpushx.js";
+export * from "./sadd.js";
+export * from "./scan.js";
+export * from "./scard.js";
+export * from "./script_exists.js";
+export * from "./script_flush.js";
+export * from "./script_load.js";
+export * from "./sdiff.js";
+export * from "./sdiffstore.js";
+export * from "./set.js";
+export * from "./setbit.js";
+export * from "./setex.js";
+export * from "./setnx.js";
+export * from "./setrange.js";
+export * from "./sinter.js";
+export * from "./sinterstore.js";
+export * from "./sismember.js";
+export * from "./smembers.js";
+export * from "./smove.js";
+export * from "./spop.js";
+export * from "./srandmember.js";
+export * from "./srem.js";
+export * from "./sscan.js";
+export * from "./strlen.js";
+export * from "./sunion.js";
+export * from "./sunionstore.js";
+export * from "./time.js";
+export * from "./touch.js";
+export * from "./ttl.js";
+export * from "./type.js";
+export * from "./unlink.js";
+export * from "./zadd.js";
+export * from "./zcard.js";
+export * from "./zcount.js";
+export * from "./zincrby.js";
+export * from "./zinterstore.js";
+export * from "./zlexcount.js";
+export * from "./zpopmax.js";
+export * from "./zpopmin.js";
+export * from "./zrange.js";
+export * from "./zrank.js";
+export * from "./zrem.js";
+export * from "./zremrangebylex.js";
+export * from "./zremrangebyrank.js";
+export * from "./zremrangebyscore.js";
+export * from "./zrevrank.js";
+export * from "./zscan.js";
+export * from "./zscore.js";
+export * from "./zunionstore.js";

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

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/mset
+ */
+export declare class MSetCommand<TData> extends Command<"OK", "OK"> {
+    constructor(kv: {
+        [key: string]: TData;
+    });
+}

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

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

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/persist
+ */
+export declare class PersistCommand extends Command<0 | 1, "0" | "1"> {
+    constructor(key: string);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/pexpire
+ */
+export declare class PExpireCommand extends Command<0 | 1, "0" | "1"> {
+    constructor(key: string, milliseconds: number);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/pexpireat
+ */
+export declare class PExpireAtCommand extends Command<0 | 1, "0" | "1"> {
+    constructor(key: string, unix: number);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/ping
+ */
+export declare class PingCommand extends Command<string | "PONG", string | "PONG"> {
+    constructor(message?: string);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/psetex
+ */
+export declare class PSetEXCommand<TData = string> extends Command<string, string> {
+    constructor(key: string, ttl: number, value: TData);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/pttl
+ */
+export declare class PTtlCommand extends Command<number, number> {
+    constructor(key: string);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/publish
+ */
+export declare class PublishCommand<TMessage = unknown> extends Command<number, number> {
+    constructor(channel: string, message: TMessage);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/randomkey
+ */
+export declare class RandomKeyCommand extends Command<string | null, string | null> {
+    constructor();
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/rename
+ */
+export declare class RenameCommand extends Command<"OK", "OK"> {
+    constructor(source: string, destination: string);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/renamenx
+ */
+export declare class RenameNXCommand extends Command<0 | 1, "0" | "1"> {
+    constructor(source: string, destination: string);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/rpop
+ */
+export declare class RPopCommand<TData = string> extends Command<TData | null, unknown | null> {
+    constructor(key: string);
+}

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

@@ -0,0 +1,8 @@
+import { NonEmptyArray } from "../types.js";
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/rpush
+ */
+export declare class RPushCommand<TData = string> extends Command<number, number> {
+    constructor(key: string, ...elements: NonEmptyArray<TData>);
+}

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

@@ -0,0 +1,8 @@
+import { NonEmptyArray } from "../types.js";
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/rpushx
+ */
+export declare class RPushXCommand<TData = string> extends Command<number, number> {
+    constructor(key: string, ...elements: NonEmptyArray<TData>);
+}

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

@@ -0,0 +1,8 @@
+import { NonEmptyArray } from "../types.js";
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/sadd
+ */
+export declare class SAddCommand<TData = string> extends Command<number, number> {
+    constructor(key: string, ...members: NonEmptyArray<TData>);
+}

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

@@ -0,0 +1,11 @@
+import { Command } from "./command.js";
+export declare type ScanCommandOptions = {
+    match?: string;
+    count?: number;
+};
+/**
+ * @see https://redis.io/commands/scan
+ */
+export declare class ScanCommand extends Command<[number, string[]], [number, string[]]> {
+    constructor(cursor: number, opts?: ScanCommandOptions);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/scard
+ */
+export declare class SCardCommand extends Command<number, number> {
+    constructor(key: string);
+}

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

@@ -0,0 +1,12 @@
+import { Command } 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(...hash: T);
+}
+export {};

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

@@ -0,0 +1,14 @@
+import { Command } from "./command.js";
+export declare type ScriptFlushCommandOptions = {
+    sync: true;
+    async?: never;
+} | {
+    sync?: never;
+    async: true;
+};
+/**
+ * @see https://redis.io/commands/script-flush
+ */
+export declare class ScriptFlushCommand extends Command<"OK", "OK"> {
+    constructor(opts?: ScriptFlushCommandOptions);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/script-load
+ */
+export declare class ScriptLoadCommand extends Command<string, string> {
+    constructor(script: string);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/sdiff
+ */
+export declare class SDiffCommand<TData> extends Command<TData[], unknown[]> {
+    constructor(key: string, ...keys: string[]);
+}

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

@@ -0,0 +1,8 @@
+import { NonEmptyArray } from "../types.js";
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/sdiffstpre
+ */
+export declare class SDiffStoreCommand extends Command<number, number> {
+    constructor(destination: string, ...keys: NonEmptyArray<string>);
+}

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

@@ -0,0 +1,26 @@
+import { Command } from "./command.js";
+export declare type SetCommandOptions = ({
+    ex: number;
+    px?: never;
+} | {
+    ex?: never;
+    px: number;
+} | {
+    ex?: never;
+    px?: never;
+}) & ({
+    nx: true;
+    xx?: never;
+} | {
+    xx: true;
+    nx?: never;
+} | {
+    xx?: never;
+    nx?: never;
+});
+/**
+ * @see https://redis.io/commands/set
+ */
+export declare class SetCommand<TData, TResult = "OK"> extends Command<TData, TResult> {
+    constructor(key: string, value: TData, opts?: SetCommandOptions);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/setbit
+ */
+export declare class SetBitCommand extends Command<0 | 1, "0" | "1"> {
+    constructor(key: string, offset: number, value: 0 | 1);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/setex
+ */
+export declare class SetExCommand<TData = string> extends Command<"OK", "OK"> {
+    constructor(key: string, ttl: number, value: TData);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/setnx
+ */
+export declare class SetNxCommand<TData = string> extends Command<number, number> {
+    constructor(key: string, value: TData);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/setrange
+ */
+export declare class SetRangeCommand extends Command<number, number> {
+    constructor(key: string, offset: number, value: string);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/sinter
+ */
+export declare class SInterCommand<TData = string> extends Command<TData[], unknown[]> {
+    constructor(key: string, ...keys: string[]);
+}