@upstash/redis 0.2.0 → 1.0.0-alpha.1

package/dist/zunionstore-462de5d3.d.ts

@@ -0,0 +1,695 @@
+declare type HttpRequest = {
+    path?: string[];
+    /**
+     * Request body will be serialized to json
+     */
+    body?: unknown;
+    headers?: Record<string, string>;
+    retries?: number;
+};
+declare type HttpClientConfig = {
+    headers?: Record<string, string>;
+    baseUrl: string;
+    options?: {
+        backend?: string;
+    };
+};
+declare class HttpClient {
+    baseUrl: string;
+    headers: Record<string, string>;
+    readonly options?: {
+        backend?: string;
+    };
+    constructor(config: HttpClientConfig);
+    private request;
+    post<TResponse>(req: HttpRequest): Promise<TResponse>;
+}
+
+/**
+ * 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.
+ */
+declare abstract class Command<TData, TResult> {
+    readonly command: string[];
+    deserialize: (result: 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;
+    });
+    /**
+     * Execute the command using a client.
+     */
+    exec(client: HttpClient): Promise<TData>;
+}
+
+/**
+ * @see https://redis.io/commands/append
+ */
+declare class AppendCommand extends Command<number, number> {
+    constructor(key: string, value: string);
+}
+
+/**
+ * @see https://redis.io/commands/bitcount
+ */
+declare class BitCountCommand extends Command<number, number> {
+    constructor(key: string, start?: never, end?: never);
+    constructor(key: string, start: number, end: number);
+}
+
+/**
+ * @see https://redis.io/commands/bitpos
+ */
+declare class BitPosCommand extends Command<number, number> {
+    constructor(key: string, start: number, end: number);
+}
+
+/**
+ * @see https://redis.io/commands/decr
+ */
+declare class DecrCommand extends Command<number, number> {
+    constructor(key: string);
+}
+
+/**
+ * @see https://redis.io/commands/decrby
+ */
+declare class DecrByCommand extends Command<number, number> {
+    constructor(key: string, decrement: number);
+}
+
+declare type NonEmptyArray<T> = [T, ...T[]];
+declare type CommandArgs<TCommand extends new (...args: any) => any> = ConstructorParameters<TCommand>;
+
+/**
+ * @see https://redis.io/commands/del
+ */
+declare class DelCommand extends Command<number, number> {
+    constructor(...keys: NonEmptyArray<string>);
+}
+
+/**
+ * @see https://redis.io/commands/echo
+ */
+declare class EchoCommand extends Command<string, string> {
+    constructor(message: string);
+}
+
+/**
+ * @see https://redis.io/commands/exists
+ */
+declare class ExistsCommand extends Command<0 | 1, "0" | "1"> {
+    constructor(...keys: NonEmptyArray<string>);
+}
+
+/**
+ * @see https://redis.io/commands/expire
+ */
+declare class ExpireCommand extends Command<0 | 1, "0" | "1"> {
+    constructor(key: string, seconds: number);
+}
+
+/**
+ * @see https://redis.io/commands/expireat
+ */
+declare class ExpireAtCommand extends Command<0 | 1, "0" | "1"> {
+    constructor(key: string, unix: number);
+}
+
+/**
+ * @see https://redis.io/commands/flushall
+ */
+declare class FlushAllCommand extends Command<"OK", "OK"> {
+    constructor(opts?: {
+        async?: boolean;
+    });
+}
+
+/**
+ * @see https://redis.io/commands/flushdb
+ */
+declare class FlushDBCommand extends Command<"OK", "OK"> {
+    constructor(opts?: {
+        async?: boolean;
+    });
+}
+
+/**
+ * @see https://redis.io/commands/get
+ */
+declare class GetCommand<TData = string> extends Command<TData | null, unknown | null> {
+    constructor(key: string);
+}
+
+/**
+ * @see https://redis.io/commands/getbit
+ */
+declare class GetBitCommand extends Command<0 | 1, "0" | "1"> {
+    constructor(key: string, offset: number);
+}
+
+/**
+ * @see https://redis.io/commands/getrange
+ */
+declare class GetRangeCommand extends Command<string, string> {
+    constructor(key: string, start: number, end: number);
+}
+
+/**
+ * @see https://redis.io/commands/hdel
+ */
+declare class HDelCommand extends Command<0 | 1, "0" | "1"> {
+    constructor(key: string, field: string);
+}
+
+/**
+ * @see https://redis.io/commands/hexists
+ */
+declare class HExistsCommand extends Command<number, number> {
+    constructor(key: string, field: string);
+}
+
+/**
+ * @see https://redis.io/commands/hget
+ */
+declare class HGetCommand<TData> extends Command<TData | null, unknown | null> {
+    constructor(key: string, field: string);
+}
+
+/**
+ * @see https://redis.io/commands/hgetall
+ */
+declare class HGetAllCommand<TData extends Record<string, unknown>> extends Command<TData | null, unknown | null> {
+    constructor(key: string);
+}
+
+/**
+ * @see https://redis.io/commands/hincrby
+ */
+declare class HIncrByCommand extends Command<number, number> {
+    constructor(key: string, field: string, increment: number);
+}
+
+/**
+ * @see https://redis.io/commands/hincrbyfloat
+ */
+declare class HIncrByFloatCommand extends Command<number, number> {
+    constructor(key: string, field: string, increment: number);
+}
+
+/**
+ * @see https://redis.io/commands/hkeys
+ */
+declare class HKeysCommand extends Command<string[], string[]> {
+    constructor(key: string);
+}
+
+/**
+ * @see https://redis.io/commands/hlen
+ */
+declare class HLenCommand extends Command<number, number> {
+    constructor(key: string);
+}
+
+/**
+ * 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
+ */
+declare class HMGetCommand<TData extends Record<string, unknown>> extends Command<TData | null, (string | null)[]> {
+    constructor(key: string, ...fields: string[]);
+}
+
+declare type ScanCommandOptions = {
+    match?: string;
+    count?: number;
+};
+/**
+ * @see https://redis.io/commands/scan
+ */
+declare class ScanCommand extends Command<[number, string[]], [number, string[]]> {
+    constructor(cursor: number, opts?: ScanCommandOptions);
+}
+
+/**
+ * @see https://redis.io/commands/hscan
+ */
+declare class HScanCommand extends Command<[
+    number,
+    (string | number)[]
+], [
+    number,
+    (string | number)[]
+]> {
+    constructor(key: string, cursor: number, opts?: ScanCommandOptions);
+}
+
+/**
+ * @see https://redis.io/commands/hstrlen
+ */
+declare class HStrLenCommand extends Command<number, number> {
+    constructor(key: string, field: string);
+}
+
+/**
+ * @see https://redis.io/commands/hvals
+ */
+declare class HValsCommand<TData extends unknown[]> extends Command<TData, unknown[]> {
+    constructor(key: string);
+}
+
+/**
+ * @see https://redis.io/commands/incr
+ */
+declare class IncrCommand extends Command<number, number> {
+    constructor(key: string);
+}
+
+/**
+ * @see https://redis.io/commands/incrby
+ */
+declare class IncrByCommand extends Command<number, number> {
+    constructor(key: string, value: number);
+}
+
+/**
+ * @see https://redis.io/commands/incrbyfloat
+ */
+declare class IncrByFloatCommand extends Command<number, number> {
+    constructor(key: string, value: number);
+}
+
+/**
+ * @see https://redis.io/commands/keys
+ */
+declare class KeysCommand extends Command<string[], string[]> {
+    constructor(pattern: string);
+}
+
+declare class LIndexCommand<TData = string> extends Command<TData | null, unknown | null> {
+    constructor(key: string, index: number);
+}
+
+/**
+ * @see https://redis.io/commands/llen
+ */
+declare class LLenCommand extends Command<number, number> {
+    constructor(key: string);
+}
+
+/**
+ * @see https://redis.io/commands/lpop
+ */
+declare class LPopCommand<TData = string> extends Command<TData | null, unknown | null> {
+    constructor(key: string);
+}
+
+declare class LRangeCommand<TData = string> extends Command<TData[], unknown[]> {
+    constructor(key: string, start: number, end: number);
+}
+
+declare class LTrimCommand extends Command<"OK", "OK"> {
+    constructor(key: string, start: number, end: number);
+}
+
+/**
+ * @see https://redis.io/commands/mget
+ */
+declare class MGetCommand<TData extends unknown[]> extends Command<TData, (string | null)[]> {
+    constructor(...keys: [string, ...string[]]);
+}
+
+/**
+ * @see https://redis.io/commands/persist
+ */
+declare class PersistCommand extends Command<0 | 1, "0" | "1"> {
+    constructor(key: string);
+}
+
+/**
+ * @see https://redis.io/commands/pexpire
+ */
+declare class PExpireCommand extends Command<0 | 1, "0" | "1"> {
+    constructor(key: string, milliseconds: number);
+}
+
+/**
+ * @see https://redis.io/commands/pexpireat
+ */
+declare class PExpireAtCommand extends Command<0 | 1, "0" | "1"> {
+    constructor(key: string, unix: number);
+}
+
+/**
+ * @see https://redis.io/commands/ping
+ */
+declare class PingCommand extends Command<string | "PONG", string | "PONG"> {
+    constructor(message?: string);
+}
+
+/**
+ * @see https://redis.io/commands/pttl
+ */
+declare class PTtlCommand extends Command<number, number> {
+    constructor(key: string);
+}
+
+/**
+ * @see https://redis.io/commands/rename
+ */
+declare class RenameCommand extends Command<"OK", "OK"> {
+    constructor(source: string, destination: string);
+}
+
+/**
+ * @see https://redis.io/commands/renamenx
+ */
+declare class RenameNXCommand extends Command<0 | 1, "0" | "1"> {
+    constructor(source: string, destination: string);
+}
+
+/**
+ * @see https://redis.io/commands/rpop
+ */
+declare class RPopCommand<TData = string> extends Command<TData | null, unknown | null> {
+    constructor(key: string);
+}
+
+/**
+ * @see https://redis.io/commands/scard
+ */
+declare class SCardCommand extends Command<number, number> {
+    constructor(key: string);
+}
+
+/**
+ * @see https://redis.io/commands/sdiff
+ */
+declare class SDiffCommand<TData> extends Command<TData[], unknown[]> {
+    constructor(key: string, ...keys: string[]);
+}
+
+/**
+ * @see https://redis.io/commands/sdiffstpre
+ */
+declare class SDiffStoreCommand extends Command<number, number> {
+    constructor(destination: string, ...keys: NonEmptyArray<string>);
+}
+
+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
+ */
+declare class SetCommand<TData, TResult = "OK"> extends Command<TData, TResult> {
+    constructor(key: string, value: TData, opts?: SetCommandOptions);
+}
+
+/**
+ * @see https://redis.io/commands/setbit
+ */
+declare class SetBitCommand extends Command<0 | 1, "0" | "1"> {
+    constructor(key: string, offset: number, value: 0 | 1);
+}
+
+/**
+ * @see https://redis.io/commands/setrange
+ */
+declare class SetRangeCommand extends Command<number, number> {
+    constructor(key: string, offset: number, value: string);
+}
+
+/**
+ * @see https://redis.io/commands/sinter
+ */
+declare class SInterCommand<TData = string> extends Command<TData[], unknown[]> {
+    constructor(key: string, ...keys: string[]);
+}
+
+/**
+ * @see https://redis.io/commands/sinterstore
+ */
+declare class SInterStoreCommand<TData = string> extends Command<TData[], unknown[]> {
+    constructor(destination: string, key: string, ...keys: string[]);
+}
+
+/**
+ * @see https://redis.io/commands/smembers
+ */
+declare class SMembersCommand<TData = string> extends Command<TData[], unknown[]> {
+    constructor(key: string);
+}
+
+/**
+ * @see https://redis.io/commands/spop
+ */
+declare class SPopCommand<TData = number> extends Command<TData | null, string | null> {
+    constructor(key: string, count?: number);
+}
+
+/**
+ * @see https://redis.io/commands/srandmember
+ */
+declare class SRandMemberCommand<TData> extends Command<TData | null, string | null> {
+    constructor(key: string, count?: number);
+}
+
+/**
+ * @see https://redis.io/commands/sscan
+ */
+declare class SScanCommand extends Command<[
+    number,
+    (string | number)[]
+], [
+    number,
+    (string | number)[]
+]> {
+    constructor(key: string, cursor: number, opts?: ScanCommandOptions);
+}
+
+/**
+ * @see https://redis.io/commands/strlen
+ */
+declare class StrLenCommand extends Command<number, number> {
+    constructor(key: string);
+}
+
+/**
+ * @see https://redis.io/commands/sunion
+ */
+declare class SUnionCommand<TData> extends Command<TData[], string[]> {
+    constructor(key: string, ...keys: string[]);
+}
+
+/**
+ * @see https://redis.io/commands/sunionstore
+ */
+declare class SUnionStoreCommand extends Command<number, number> {
+    constructor(destination: string, key: string, ...keys: string[]);
+}
+
+/**
+ * @see https://redis.io/commands/touch
+ */
+declare class TouchCommand extends Command<number, number> {
+    constructor(...keys: string[]);
+}
+
+/**
+ * @see https://redis.io/commands/ttl
+ */
+declare class TtlCommand extends Command<number, number> {
+    constructor(key: string);
+}
+
+declare type Type = "string" | "list" | "set" | "zset" | "hash" | "none";
+/**
+ * @see https://redis.io/commands/type
+ */
+declare class TypeCommand extends Command<Type, Type> {
+    constructor(key: string);
+}
+
+/**
+ * @see https://redis.io/commands/unlink
+ */
+declare class UnlinkCommand extends Command<number, number> {
+    constructor(...keys: string[]);
+}
+
+declare type ZAddCommandOptions = ({
+    nx: true;
+    xx?: never;
+} | {
+    nx?: never;
+    xx: true;
+} | {
+    nx?: never;
+    xx?: never;
+}) & {
+    ch?: true;
+};
+declare type ZAddCommandOptionsWithIncr = ZAddCommandOptions & {
+    incr: true;
+};
+declare type ScoreMember<TData> = {
+    score: number;
+    member: TData;
+};
+/**
+ * @see https://redis.io/commands/zadd
+ */
+declare class ZAddCommand<TData = string> extends Command<number | null, number | null> {
+    constructor(key: string, scoreMember: ScoreMember<TData>, ...scoreMemberPairs: ScoreMember<TData>[]);
+    constructor(key: string, opts: ZAddCommandOptions | ZAddCommandOptionsWithIncr, ...scoreMemberPairs: [ScoreMember<TData>, ...ScoreMember<TData>[]]);
+}
+
+/**
+ * @see https://redis.io/commands/zcard
+ */
+declare class ZCardCommand extends Command<number, number> {
+    constructor(key: string);
+}
+
+/**
+ * @see https://redis.io/commands/zcount
+ */
+declare class ZCountCommand extends Command<number, number> {
+    constructor(key: string, min: number | string, max: number | string);
+}
+
+declare type ZInterStoreCommandOptions = {
+    aggregate?: "sum" | "min" | "max";
+} & ({
+    weight: number;
+    weights?: never;
+} | {
+    weight?: never;
+    weights: number[];
+} | {
+    weight?: never;
+    weights?: never;
+});
+/**
+ * @see https://redis.io/commands/zInterstore
+ */
+declare class ZInterStoreCommand extends Command<number, number> {
+    constructor(destination: string, numKeys: 1, key: string, opts?: ZInterStoreCommandOptions);
+    constructor(destination: string, numKeys: number, keys: string[], opts?: ZInterStoreCommandOptions);
+}
+
+/**
+ * @see https://redis.io/commands/zlexcount
+ */
+declare class ZLexCountCommand extends Command<number, number> {
+    constructor(key: string, min: string, max: string);
+}
+
+/**
+ * @see https://redis.io/commands/zpopmax
+ */
+declare class ZPopMaxCommand<TData> extends Command<TData[], string[]> {
+    constructor(key: string, count?: number);
+}
+
+/**
+ * @see https://redis.io/commands/zpopmin
+ */
+declare class ZPopMinCommand<TData> extends Command<TData[], string[]> {
+    constructor(key: string, count?: number);
+}
+
+declare type ZRangeCommandOptions = {
+    withScores?: boolean;
+};
+/**
+ * @see https://redis.io/commands/zrange
+ */
+declare class ZRangeCommand<TData extends unknown[]> extends Command<TData, string[]> {
+    constructor(key: string, min: number | `(${number}`, max: number | `(${number}`, opts?: ZRangeCommandOptions);
+}
+
+/**
+ * @see https://redis.io/commands/zremrangebylex
+ */
+declare class ZRemRangeByLexCommand extends Command<number, number> {
+    constructor(key: string, min: string, max: string);
+}
+
+/**
+ * @see https://redis.io/commands/zremrangebyrank
+ */
+declare class ZRemRangeByRankCommand extends Command<number, number> {
+    constructor(key: string, start: number, stop: number);
+}
+
+/**
+ * @see https://redis.io/commands/zremrangebyscore
+ */
+declare class ZRemRangeByScoreCommand extends Command<number, number> {
+    constructor(key: string, min: number, max: number);
+}
+
+/**
+ * @see https://redis.io/commands/zscan
+ */
+declare class ZScanCommand extends Command<[
+    number,
+    (string | number)[]
+], [
+    number,
+    (string | number)[]
+]> {
+    constructor(key: string, cursor: number, opts?: ScanCommandOptions);
+}
+
+declare type ZUnionStoreCommandOptions = {
+    aggregate?: "sum" | "min" | "max";
+} & ({
+    weight: number;
+    weights?: never;
+} | {
+    weight?: never;
+    weights: number[];
+} | {
+    weight?: never;
+    weights?: never;
+});
+/**
+ * @see https://redis.io/commands/zunionstore
+ */
+declare class ZUnionStoreCommand extends Command<number, number> {
+    constructor(destination: string, numKeys: 1, key: string, opts?: ZUnionStoreCommandOptions);
+    constructor(destination: string, numKeys: number, keys: string[], opts?: ZUnionStoreCommandOptions);
+}
+
+export { SetBitCommand as $, AppendCommand as A, BitCountCommand as B, CommandArgs as C, DecrCommand as D, EchoCommand as E, FlushAllCommand as F, GetCommand as G, HttpClient as H, IncrCommand as I, LTrimCommand as J, KeysCommand as K, LIndexCommand as L, MGetCommand as M, NonEmptyArray as N, PExpireCommand as O, PersistCommand as P, PExpireAtCommand as Q, PingCommand as R, PTtlCommand as S, RenameCommand as T, RenameNXCommand as U, RPopCommand as V, ScanCommand as W, SCardCommand as X, SDiffCommand as Y, SDiffStoreCommand as Z, SetCommandOptions as _, BitPosCommand as a, SetRangeCommand as a0, SInterCommand as a1, SInterStoreCommand as a2, SMembersCommand as a3, SPopCommand as a4, SRandMemberCommand as a5, SScanCommand as a6, StrLenCommand as a7, SUnionCommand as a8, SUnionStoreCommand as a9, ZUnionStoreCommandOptions as aA, TouchCommand as aa, TtlCommand as ab, TypeCommand as ac, UnlinkCommand as ad, ScoreMember as ae, ZAddCommandOptions as af, ZAddCommandOptionsWithIncr as ag, ZCardCommand as ah, ZCountCommand as ai, ZInterStoreCommand as aj, ZLexCountCommand as ak, ZPopMaxCommand as al, ZPopMinCommand as am, ZRangeCommand as an, ZRemRangeByLexCommand as ao, ZRemRangeByRankCommand as ap, ZRemRangeByScoreCommand as aq, ZScanCommand as ar, ZUnionStoreCommand as as, Type as at, Command as au, ScanCommandOptions as av, SetCommand as aw, ZAddCommand as ax, ZInterStoreCommandOptions as ay, ZRangeCommandOptions as az, DecrByCommand as b, DelCommand as c, ExistsCommand as d, ExpireCommand as e, ExpireAtCommand as f, FlushDBCommand as g, GetBitCommand as h, GetRangeCommand as i, HDelCommand as j, HExistsCommand as k, HGetCommand as l, HGetAllCommand as m, HIncrByCommand as n, HIncrByFloatCommand as o, HKeysCommand as p, HLenCommand as q, HMGetCommand as r, HScanCommand as s, HStrLenCommand as t, HValsCommand as u, IncrByCommand as v, IncrByFloatCommand as w, LLenCommand as x, LPopCommand as y, LRangeCommand as z };