@upstash/redis 0.0.0-ci.fb6b986f-20221006 → 0.0.0-ci.fc1b22d0-20231019

package/types/pkg/redis.d.ts

@@ -1,534 +0,0 @@
-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";
-import { Script } from "./script.js";
-export declare type RedisOptions = {
-    /**
-     * Automatically try to deserialize the returned data from upstash using `JSON.deserialize`
-     *
-     * @default true
-     */
-    automaticDeserialization?: boolean;
-};
-/**
- * Serverless redis client for upstash.
- */
-export declare class Redis {
-    protected client: Requester;
-    protected opts?: CommandOptions<any, any>;
-    /**
-     * Create a new redis client
-     *
-     * @example
-     * ```typescript
-     * const redis = new Redis({
-     *  url: "<UPSTASH_REDIS_REST_URL>",
-     *  token: "<UPSTASH_REDIS_REST_TOKEN>",
-     * });
-     * ```
-     */
-    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;
-    createScript(script: string): Script;
-    /**
-     * Create a new pipeline that allows you to send requests in bulk.
-     *
-     * @see {@link Pipeline}
-     */
-    pipeline: () => Pipeline;
-    /**
-     * @see https://redis.io/commands/append
-     */
-    append: (key: string, value: string) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/bitcount
-     */
-    bitcount: (key: string, start: number, end: number) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/bitop
-     */
-    bitop: {
-        (op: "and" | "or" | "xor", destinationKey: string, sourceKey: string, ...sourceKeys: string[]): Promise<number>;
-        (op: "not", destinationKey: string, sourceKey: string): Promise<number>;
-    };
-    /**
-     * @see https://redis.io/commands/bitpos
-     */
-    bitpos: (key: string, bit: 0 | 1, start?: number | undefined, end?: number | undefined) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/dbsize
-     */
-    dbsize: () => Promise<number>;
-    /**
-     * @see https://redis.io/commands/decr
-     */
-    decr: (key: string) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/decrby
-     */
-    decrby: (key: string, decrement: number) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/del
-     */
-    del: (...args: CommandArgs<typeof DelCommand>) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/echo
-     */
-    echo: (message: string) => Promise<string>;
-    /**
-     * @see https://redis.io/commands/eval
-     */
-    eval: <TArgs extends unknown[], TData = unknown>(script: string, keys: string[], args: TArgs) => Promise<TData>;
-    /**
-     * @see https://redis.io/commands/evalsha
-     */
-    evalsha: <TArgs extends unknown[], TData = unknown>(sha1: string, keys: string[], args: TArgs) => Promise<TData>;
-    /**
-     * @see https://redis.io/commands/exists
-     */
-    exists: (...args: CommandArgs<typeof ExistsCommand>) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/expire
-     */
-    expire: (key: string, seconds: number) => Promise<0 | 1>;
-    /**
-     * @see https://redis.io/commands/expireat
-     */
-    expireat: (key: string, unix: number) => Promise<0 | 1>;
-    /**
-     * @see https://redis.io/commands/flushall
-     */
-    flushall: (args?: CommandArgs<typeof FlushAllCommand>) => Promise<"OK">;
-    /**
-     * @see https://redis.io/commands/flushdb
-     */
-    flushdb: (opts?: {
-        async?: boolean | undefined;
-    } | undefined) => Promise<"OK">;
-    /**
-     * @see https://redis.io/commands/get
-     */
-    get: <TData>(key: string) => Promise<TData | null>;
-    /**
-     * @see https://redis.io/commands/getbit
-     */
-    getbit: (key: string, offset: number) => Promise<0 | 1>;
-    /**
-     * @see https://redis.io/commands/getrange
-     */
-    getrange: (key: string, start: number, end: number) => Promise<string>;
-    /**
-     * @see https://redis.io/commands/getset
-     */
-    getset: <TData>(key: string, value: TData) => Promise<TData | null>;
-    /**
-     * @see https://redis.io/commands/hdel
-     */
-    hdel: (key: string, field: string) => Promise<0 | 1>;
-    /**
-     * @see https://redis.io/commands/hexists
-     */
-    hexists: (key: string, field: string) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/hget
-     */
-    hget: <TData>(key: string, field: string) => Promise<TData | null>;
-    /**
-     * @see https://redis.io/commands/hgetall
-     */
-    hgetall: <TData extends Record<string, unknown>>(key: string) => Promise<TData | null>;
-    /**
-     * @see https://redis.io/commands/hincrby
-     */
-    hincrby: (key: string, field: string, increment: number) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/hincrbyfloat
-     */
-    hincrbyfloat: (key: string, field: string, increment: number) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/hkeys
-     */
-    hkeys: (key: string) => Promise<string[]>;
-    /**
-     * @see https://redis.io/commands/hlen
-     */
-    hlen: (key: string) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/hmget
-     */
-    hmget: <TData extends Record<string, unknown>>(key: string, ...fields: string[]) => Promise<TData | null>;
-    /**
-     * @see https://redis.io/commands/hmset
-     */
-    hmset: <TData>(key: string, kv: {
-        [field: string]: TData;
-    }) => Promise<"OK">;
-    /**
-     * @see https://redis.io/commands/hscan
-     */
-    hscan: (key: string, cursor: number, cmdOpts?: import("./commands/scan.js").ScanCommandOptions | undefined) => Promise<[number, (string | number)[]]>;
-    /**
-     * @see https://redis.io/commands/hset
-     */
-    hset: <TData>(key: string, kv: {
-        [field: string]: TData;
-    }) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/hsetnx
-     */
-    hsetnx: <TData>(key: string, field: string, value: TData) => Promise<0 | 1>;
-    /**
-     * @see https://redis.io/commands/hstrlen
-     */
-    hstrlen: (key: string, field: string) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/hvals
-     */
-    hvals: (key: string) => Promise<any>;
-    /**
-     * @see https://redis.io/commands/incr
-     */
-    incr: (key: string) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/incrby
-     */
-    incrby: (key: string, value: number) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/incrbyfloat
-     */
-    incrbyfloat: (key: string, value: number) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/keys
-     */
-    keys: (pattern: string) => Promise<string[]>;
-    /**
-     * @see https://redis.io/commands/lindex
-     */
-    lindex: (key: string, index: number) => Promise<any>;
-    /**
-     * @see https://redis.io/commands/linsert
-     */
-    linsert: <TData>(key: string, direction: "before" | "after", pivot: TData, value: TData) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/llen
-     */
-    llen: (key: string) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/lpop
-     */
-    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
-     */
-    lpush: <TData>(key: string, ...elements: TData[]) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/lpushx
-     */
-    lpushx: <TData>(key: string, ...elements: TData[]) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/lrange
-     */
-    lrange: <TResult = string>(key: string, start: number, end: number) => Promise<TResult[]>;
-    /**
-     * @see https://redis.io/commands/lrem
-     */
-    lrem: <TData>(key: string, count: number, value: TData) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/lset
-     */
-    lset: <TData>(key: string, index: number, value: TData) => Promise<"OK">;
-    /**
-     * @see https://redis.io/commands/ltrim
-     */
-    ltrim: (key: string, start: number, end: number) => Promise<"OK">;
-    /**
-     * @see https://redis.io/commands/mget
-     */
-    mget: <TData extends unknown[]>(...args: CommandArgs<typeof MGetCommand>) => Promise<TData>;
-    /**
-     * @see https://redis.io/commands/mset
-     */
-    mset: <TData>(kv: {
-        [key: string]: TData;
-    }) => Promise<"OK">;
-    /**
-     * @see https://redis.io/commands/msetnx
-     */
-    msetnx: <TData>(kv: {
-        [key: string]: TData;
-    }) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/persist
-     */
-    persist: (key: string) => Promise<0 | 1>;
-    /**
-     * @see https://redis.io/commands/pexpire
-     */
-    pexpire: (key: string, milliseconds: number) => Promise<0 | 1>;
-    /**
-     * @see https://redis.io/commands/pexpireat
-     */
-    pexpireat: (key: string, unix: number) => Promise<0 | 1>;
-    /**
-     * @see https://redis.io/commands/ping
-     */
-    ping: (args?: CommandArgs<typeof PingCommand>) => Promise<string>;
-    /**
-     * @see https://redis.io/commands/psetex
-     */
-    psetex: <TData>(key: string, ttl: number, value: TData) => Promise<string>;
-    /**
-     * @see https://redis.io/commands/pttl
-     */
-    pttl: (key: string) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/publish
-     */
-    publish: (channel: string, message: unknown) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/randomkey
-     */
-    randomkey: () => Promise<string | null>;
-    /**
-     * @see https://redis.io/commands/rename
-     */
-    rename: (source: string, destination: string) => Promise<"OK">;
-    /**
-     * @see https://redis.io/commands/renamenx
-     */
-    renamenx: (source: string, destination: string) => Promise<0 | 1>;
-    /**
-     * @see https://redis.io/commands/rpop
-     */
-    rpop: <TData = string>(key: string, count?: number | undefined) => Promise<TData | null>;
-    /**
-     * @see https://redis.io/commands/rpush
-     */
-    rpush: <TData>(key: string, ...elements: TData[]) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/rpushx
-     */
-    rpushx: <TData>(key: string, ...elements: TData[]) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/sadd
-     */
-    sadd: <TData>(key: string, ...members: TData[]) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/scan
-     */
-    scan: (cursor: number, opts?: import("./commands/scan.js").ScanCommandOptions | undefined) => Promise<[number, string[]]>;
-    /**
-     * @see https://redis.io/commands/scard
-     */
-    scard: (key: string) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/script-exists
-     */
-    scriptExists: (...args: CommandArgs<typeof ScriptExistsCommand>) => Promise<number[]>;
-    /**
-     * @see https://redis.io/commands/script-flush
-     */
-    scriptFlush: (opts?: import("./commands/script_flush.js").ScriptFlushCommandOptions | undefined) => Promise<"OK">;
-    /**
-     * @see https://redis.io/commands/script-load
-     */
-    scriptLoad: (script: string) => Promise<string>;
-    /**
-     * @see https://redis.io/commands/sdiff
-     */
-    sdiff: (key: string, ...keys: string[]) => Promise<unknown[]>;
-    /**
-     * @see https://redis.io/commands/sdiffstore
-     */
-    sdiffstore: (destination: string, ...keys: string[]) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/set
-     */
-    set: <TData>(key: string, value: TData, opts?: SetCommandOptions) => Promise<"OK" | TData | null>;
-    /**
-     * @see https://redis.io/commands/setbit
-     */
-    setbit: (key: string, offset: number, value: 0 | 1) => Promise<0 | 1>;
-    /**
-     * @see https://redis.io/commands/setex
-     */
-    setex: <TData>(key: string, ttl: number, value: TData) => Promise<"OK">;
-    /**
-     * @see https://redis.io/commands/setnx
-     */
-    setnx: <TData>(key: string, value: TData) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/setrange
-     */
-    setrange: (key: string, offset: number, value: string) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/sinter
-     */
-    sinter: (key: string, ...keys: string[]) => Promise<string[]>;
-    /**
-     * @see https://redis.io/commands/sinterstore
-     */
-    sinterstore: (destination: string, key: string, ...keys: string[]) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/sismember
-     */
-    sismember: <TData>(key: string, member: TData) => Promise<0 | 1>;
-    /**
-     * @see https://redis.io/commands/smembers
-     */
-    smembers: (key: string) => Promise<string[]>;
-    /**
-     * @see https://redis.io/commands/smove
-     */
-    smove: <TData>(source: string, destination: string, member: TData) => Promise<0 | 1>;
-    /**
-     * @see https://redis.io/commands/spop
-     */
-    spop: <TData>(key: string, count?: number | undefined) => Promise<TData | null>;
-    /**
-     * @see https://redis.io/commands/srandmember
-     */
-    srandmember: <TData>(key: string, count?: number | undefined) => Promise<TData | null>;
-    /**
-     * @see https://redis.io/commands/srem
-     */
-    srem: <TData>(key: string, ...members: TData[]) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/sscan
-     */
-    sscan: (key: string, cursor: number, opts?: import("./commands/scan.js").ScanCommandOptions | undefined) => Promise<[number, (string | number)[]]>;
-    /**
-     * @see https://redis.io/commands/strlen
-     */
-    strlen: (key: string) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/sunion
-     */
-    sunion: (key: string, ...keys: string[]) => Promise<unknown[]>;
-    /**
-     * @see https://redis.io/commands/sunionstore
-     */
-    sunionstore: (destination: string, key: string, ...keys: string[]) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/time
-     */
-    time: () => Promise<[number, number]>;
-    /**
-     * @see https://redis.io/commands/touch
-     */
-    touch: (...args: CommandArgs<typeof TouchCommand>) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/ttl
-     */
-    ttl: (key: string) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/type
-     */
-    type: (key: string) => Promise<import("./commands/type.js").Type>;
-    /**
-     * @see https://redis.io/commands/unlink
-     */
-    unlink: (...args: CommandArgs<typeof UnlinkCommand>) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/zadd
-     */
-    zadd: <TData>(...args: [key: string, scoreMember: ScoreMember<TData>, ...scoreMemberPairs: ScoreMember<TData>[]] | [string, ZAddCommandOptions | ZAddCommandOptionsWithIncr, ScoreMember<TData>, ...ScoreMember<TData>[]]) => Promise<number | null>;
-    /**
-     * @see https://redis.io/commands/zcard
-     */
-    zcard: (key: string) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/zcount
-     */
-    zcount: (key: string, min: string | number, max: string | number) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/zincrby
-     */
-    zincrby: <TData>(key: string, increment: number, member: TData) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/zinterstore
-     */
-    zinterstore: (destination: string, numKeys: number, keys: string[], opts?: import("./commands/zinterstore.js").ZInterStoreCommandOptions | undefined) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/zlexcount
-     */
-    zlexcount: (key: string, min: string, max: string) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/zmscore
-     */
-    zmscore: (key: string, members: unknown[]) => Promise<number[] | null>;
-    /**
-     * @see https://redis.io/commands/zpopmax
-     */
-    zpopmax: <TData>(key: string, count?: number | undefined) => Promise<TData[]>;
-    /**
-     * @see https://redis.io/commands/zpopmin
-     */
-    zpopmin: <TData>(key: string, count?: number | undefined) => Promise<TData[]>;
-    /**
-     * @see https://redis.io/commands/zrange
-     */
-    zrange: <TData extends unknown[]>(...args: [key: string, min: number, max: number, opts?: ZRangeCommandOptions] | [
-        key: string,
-        min: `(${string}` | `[${string}` | "-" | "+",
-        max: `(${string}` | `[${string}` | "-" | "+",
-        opts: {
-            byLex: true;
-        } & ZRangeCommandOptions
-    ] | [
-        key: string,
-        min: number | `(${number}` | "-inf" | "+inf",
-        max: number | `(${number}` | "-inf" | "+inf",
-        opts: {
-            byScore: true;
-        } & ZRangeCommandOptions
-    ]) => Promise<TData>;
-    /**
-     * @see https://redis.io/commands/zrank
-     */
-    zrank: <TData>(key: string, member: TData) => Promise<number | null>;
-    /**
-     * @see https://redis.io/commands/zrem
-     */
-    zrem: <TData>(key: string, ...members: TData[]) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/zremrangebylex
-     */
-    zremrangebylex: (key: string, min: string, max: string) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/zremrangebyrank
-     */
-    zremrangebyrank: (key: string, start: number, stop: number) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/zremrangebyscore
-     */
-    zremrangebyscore: (key: string, min: number, max: number) => Promise<number>;
-    /**
-     * @see https://redis.io/commands/zrevrank
-     */
-    zrevrank: <TData>(key: string, member: TData) => Promise<number | null>;
-    /**
-     * @see https://redis.io/commands/zscan
-     */
-    zscan: (key: string, cursor: number, opts?: import("./commands/scan.js").ScanCommandOptions | undefined) => Promise<[number, (string | number)[]]>;
-    /**
-     * @see https://redis.io/commands/zscore
-     */
-    zscore: <TData>(key: string, member: TData) => Promise<number | null>;
-    /**
-     * @see https://redis.io/commands/zunionstore
-     */
-    zunionstore: (destination: string, numKeys: number, keys: string[], opts?: import("./commands/zunionstore.js").ZUnionStoreCommandOptions | undefined) => Promise<number>;
-}

package/types/pkg/script.d.ts

@@ -1,42 +0,0 @@
-import { Redis } from "./redis.js";
-/**
- * Creates a new script.
- *
- * Scripts offer the ability to optimistically try to execute a script without having to send the
- * entire script to the server. If the script is loaded on the server, it tries again by sending
- * the entire script. Afterwards, the script is cached on the server.
- *
- * @example
- * ```ts
- * const redis = new Redis({...})
- *
- * const script = redis.createScript<string>("return ARGV[1];")
- * const arg1 = await script.eval([], ["Hello World"])
- * assertEquals(arg1, "Hello World")
- * ```
- */
-export declare class Script<TResult = unknown> {
-    readonly script: string;
-    readonly sha1: string;
-    private readonly redis;
-    constructor(redis: Redis, script: string);
-    /**
-     * Send an `EVAL` command to redis.
-     */
-    eval(keys: string[], args: string[]): Promise<TResult>;
-    /**
-     * Calculates the sha1 hash of the script and then calls `EVALSHA`.
-     */
-    evalsha(keys: string[], args: string[]): Promise<TResult>;
-    /**
-     * Optimistically try to run `EVALSHA` first.
-     * If the script is not loaded in redis, it will fall back and try again with `EVAL`.
-     *
-     * Following calls will be able to use the cached script
-     */
-    exec(keys: string[], args: string[]): Promise<TResult>;
-    /**
-     * Compute the sha1 hash of the script and return its hex representation.
-     */
-    private digest;
-}

package/types/pkg/types.d.ts

@@ -1 +0,0 @@
-export declare type CommandArgs<TCommand extends new (...args: any) => any> = ConstructorParameters<TCommand>[0];

package/types/pkg/util.d.ts

@@ -1 +0,0 @@
-export declare function parseResponse<TResult>(result: unknown): TResult;