@upstash/redis 1.34.3-canary-2 → 1.34.4

package/{zmscore-BLgYk16R.d.ts → zmscore-C3G81zLz.d.ts}

@@ -563,6 +563,50 @@ declare class GetDelCommand<TData = string> extends Command<unknown | null, TDat
     constructor(cmd: [key: string], opts?: CommandOptions<unknown | null, TData | null>);
 }
 
+type GetExCommandOptions = {
+    ex: number;
+    px?: never;
+    exat?: never;
+    pxat?: never;
+    persist?: never;
+} | {
+    ex?: never;
+    px: number;
+    exat?: never;
+    pxat?: never;
+    persist?: never;
+} | {
+    ex?: never;
+    px?: never;
+    exat: number;
+    pxat?: never;
+    persist?: never;
+} | {
+    ex?: never;
+    px?: never;
+    exat?: never;
+    pxat: number;
+    persist?: never;
+} | {
+    ex?: never;
+    px?: never;
+    exat?: never;
+    pxat?: never;
+    persist: true;
+} | {
+    ex?: never;
+    px?: never;
+    exat?: never;
+    pxat?: never;
+    persist?: never;
+};
+/**
+ * @see https://redis.io/commands/getex
+ */
+declare class GetExCommand<TData = string> extends Command<unknown | null, TData | null> {
+    constructor([key, opts]: [key: string, opts?: GetExCommandOptions], cmdOpts?: CommandOptions<unknown | null, TData | null>);
+}
+
 /**
  * @see https://redis.io/commands/getrange
  */
@@ -1602,6 +1646,39 @@ declare class ZScoreCommand<TData> extends Command<string | null, number | null>
 type InferResponseData<T extends unknown[]> = {
     [K in keyof T]: T[K] extends Command<any, infer TData> ? TData : unknown;
 };
+interface ExecMethod<TCommands extends Command<any, any>[]> {
+    /**
+     * Send the pipeline request to upstash.
+     *
+     * Returns an array with the results of all pipelined commands.
+     *
+     * If all commands are statically chained from start to finish, types are inferred. You can still define a return type manually if necessary though:
+     * ```ts
+     * const p = redis.pipeline()
+     * p.get("key")
+     * const result = p.exec<[{ greeting: string }]>()
+     * ```
+     *
+     * If one of the commands get an error, the whole pipeline fails. Alternatively, you can set the keepErrors option to true in order to get the errors individually.
+     *
+     * If keepErrors is set to true, a list of objects is returned where each object corresponds to a command and is of type: `{ result: unknown, error?: string }`.
+     *
+     * ```ts
+     * const p = redis.pipeline()
+     * p.get("key")
+     *
+     * const result = await p.exec({ keepErrors: true });
+     * const getResult = result[0].result
+     * const getError = result[0].error
+     * ```
+     */
+    <TCommandResults extends unknown[] = [] extends TCommands ? unknown[] : InferResponseData<TCommands>>(): Promise<TCommandResults>;
+    <TCommandResults extends unknown[] = [] extends TCommands ? unknown[] : InferResponseData<TCommands>>(options: {
+        keepErrors: true;
+    }): Promise<{
+        [K in keyof TCommandResults]: UpstashResponse<TCommandResults[K]>;
+    }>;
+}
 /**
  * Upstash REST API supports command pipelining to send multiple commands in
  * batch, instead of sending each command one by one and waiting for a response.
@@ -1650,19 +1727,7 @@ declare class Pipeline<TCommands extends Command<any, any>[] = []> {
         commandOptions?: CommandOptions<any, any>;
         multiExec?: boolean;
     });
-    /**
-     * Send the pipeline request to upstash.
-     *
-     * Returns an array with the results of all pipelined commands.
-     *
-     * If all commands are statically chained from start to finish, types are inferred. You can still define a return type manually if necessary though:
-     * ```ts
-     * const p = redis.pipeline()
-     * p.get("key")
-     * const result = p.exec<[{ greeting: string }]>()
-     * ```
-     */
-    exec: <TCommandResults extends unknown[] = [] extends TCommands ? unknown[] : InferResponseData<TCommands>>() => Promise<TCommandResults>;
+    exec: ExecMethod<TCommands>;
     /**
      * Returns the length of pipeline before the execution
      */
@@ -1870,6 +1935,46 @@ declare class Pipeline<TCommands extends Command<any, any>[] = []> {
      * @see https://redis.io/commands/getdel
      */
     getdel: <TData>(key: string) => Pipeline<[...TCommands, Command<any, TData | null>]>;
+    /**
+     * @see https://redis.io/commands/getex
+     */
+    getex: <TData>(key: string, opts?: ({
+        ex: number;
+        px?: never;
+        exat?: never;
+        pxat?: never;
+        persist?: never;
+    } | {
+        ex?: never;
+        px: number;
+        exat?: never;
+        pxat?: never;
+        persist?: never;
+    } | {
+        ex?: never;
+        px?: never;
+        exat: number;
+        pxat?: never;
+        persist?: never;
+    } | {
+        ex?: never;
+        px?: never;
+        exat?: never;
+        pxat: number;
+        persist?: never;
+    } | {
+        ex?: never;
+        px?: never;
+        exat?: never;
+        pxat?: never;
+        persist: true;
+    } | {
+        ex?: never;
+        px?: never;
+        exat?: never;
+        pxat?: never;
+        persist?: never;
+    }) | undefined) => Pipeline<[...TCommands, Command<any, TData | null>]>;
     /**
      * @see https://redis.io/commands/getrange
      */
@@ -2771,6 +2876,10 @@ declare class Redis {
      * @see https://redis.io/commands/evalsha
      */
     evalsha: <TArgs extends unknown[], TData = unknown>(sha1: string, keys: string[], args: TArgs) => Promise<TData>;
+    /**
+     * Generic method to execute any Redis command.
+     */
+    exec: <TResult>(args: [command: string, ...args: (string | number | boolean)[]]) => Promise<TResult>;
     /**
      * @see https://redis.io/commands/exists
      */
@@ -2895,6 +3004,46 @@ declare class Redis {
      * @see https://redis.io/commands/getdel
      */
     getdel: <TData>(key: string) => Promise<TData | null>;
+    /**
+     * @see https://redis.io/commands/getex
+     */
+    getex: <TData>(key: string, opts?: ({
+        ex: number;
+        px?: never;
+        exat?: never;
+        pxat?: never;
+        persist?: never;
+    } | {
+        ex?: never;
+        px: number;
+        exat?: never;
+        pxat?: never;
+        persist?: never;
+    } | {
+        ex?: never;
+        px?: never;
+        exat: number;
+        pxat?: never;
+        persist?: never;
+    } | {
+        ex?: never;
+        px?: never;
+        exat?: never;
+        pxat: number;
+        persist?: never;
+    } | {
+        ex?: never;
+        px?: never;
+        exat?: never;
+        pxat?: never;
+        persist: true;
+    } | {
+        ex?: never;
+        px?: never;
+        exat?: never;
+        pxat?: never;
+        persist?: never;
+    }) | undefined) => Promise<TData | null>;
     /**
      * @see https://redis.io/commands/getrange
      */
@@ -3485,4 +3634,4 @@ declare class ZMScoreCommand<TData> extends Command<string[] | null, number[] |
     constructor(cmd: [key: string, members: TData[]], opts?: CommandOptions<string[] | null, number[] | null>);
 }
 
-export { HValsCommand as $, AppendCommand as A, BitCountCommand as B, CopyCommand as C, DBSizeCommand as D, EchoCommand as E, FlushAllCommand as F, GeoAddCommand as G, GetRangeCommand as H, GetSetCommand as I, HDelCommand as J, HExistsCommand as K, HGetCommand as L, HGetAllCommand as M, HIncrByCommand as N, HIncrByFloatCommand as O, Pipeline as P, HKeysCommand as Q, type RedisOptions as R, HLenCommand as S, HMGetCommand as T, type UpstashRequest as U, HMSetCommand as V, HRandFieldCommand as W, HScanCommand as X, HSetCommand as Y, HSetNXCommand as Z, HStrLenCommand as _, type RequesterConfig as a, SetBitCommand as a$, IncrCommand as a0, IncrByCommand as a1, IncrByFloatCommand as a2, JsonArrAppendCommand as a3, JsonArrIndexCommand as a4, JsonArrInsertCommand as a5, JsonArrLenCommand as a6, JsonArrPopCommand as a7, JsonArrTrimCommand as a8, JsonClearCommand as a9, MGetCommand as aA, MSetCommand as aB, MSetNXCommand as aC, PersistCommand as aD, PExpireCommand as aE, PExpireAtCommand as aF, PingCommand as aG, PSetEXCommand as aH, PTtlCommand as aI, PublishCommand as aJ, RandomKeyCommand as aK, RenameCommand as aL, RenameNXCommand as aM, RPopCommand as aN, RPushCommand as aO, RPushXCommand as aP, SAddCommand as aQ, ScanCommand as aR, type ScanCommandOptions as aS, SCardCommand as aT, ScriptExistsCommand as aU, ScriptFlushCommand as aV, ScriptLoadCommand as aW, SDiffCommand as aX, SDiffStoreCommand as aY, SetCommand as aZ, type SetCommandOptions as a_, JsonDelCommand as aa, JsonForgetCommand as ab, JsonGetCommand as ac, JsonMGetCommand as ad, JsonNumIncrByCommand as ae, JsonNumMultByCommand as af, JsonObjKeysCommand as ag, JsonObjLenCommand as ah, JsonRespCommand as ai, JsonSetCommand as aj, JsonStrAppendCommand as ak, JsonStrLenCommand as al, JsonToggleCommand as am, JsonTypeCommand as an, KeysCommand as ao, LIndexCommand as ap, LInsertCommand as aq, LLenCommand as ar, LMoveCommand as as, LPopCommand as at, LPushCommand as au, LPushXCommand as av, LRangeCommand as aw, LRemCommand as ax, LSetCommand as ay, LTrimCommand as az, Redis as b, SetExCommand as b0, SetNxCommand as b1, SetRangeCommand as b2, SInterCommand as b3, SInterStoreCommand as b4, SIsMemberCommand as b5, SMembersCommand as b6, SMIsMemberCommand as b7, SMoveCommand as b8, SPopCommand as b9, ZPopMinCommand as bA, ZRangeCommand as bB, type ZRangeCommandOptions as bC, ZRankCommand as bD, ZRemCommand as bE, ZRemRangeByLexCommand as bF, ZRemRangeByRankCommand as bG, ZRemRangeByScoreCommand as bH, ZRevRankCommand as bI, ZScanCommand as bJ, ZScoreCommand as bK, ZUnionCommand as bL, type ZUnionCommandOptions as bM, ZUnionStoreCommand as bN, type ZUnionStoreCommandOptions as bO, SRandMemberCommand as ba, SRemCommand as bb, SScanCommand as bc, StrLenCommand as bd, SUnionCommand as be, SUnionStoreCommand as bf, TimeCommand as bg, TouchCommand as bh, TtlCommand as bi, type Type as bj, TypeCommand as bk, UnlinkCommand as bl, XAddCommand as bm, XRangeCommand as bn, type ScoreMember as bo, type ZAddCommandOptions as bp, ZAddCommand as bq, ZCardCommand as br, ZCountCommand as bs, ZDiffStoreCommand as bt, ZIncrByCommand as bu, ZInterStoreCommand as bv, type ZInterStoreCommandOptions as bw, ZLexCountCommand as bx, ZMScoreCommand as by, ZPopMaxCommand as bz, type UpstashResponse as c, type Requester as d, error as e, BitOpCommand as f, BitPosCommand as g, DecrCommand as h, DecrByCommand as i, DelCommand as j, EvalCommand as k, EvalshaCommand as l, ExistsCommand as m, ExpireCommand as n, ExpireAtCommand as o, FlushDBCommand as p, type GeoAddCommandOptions as q, type GeoMember as r, GeoDistCommand as s, GeoHashCommand as t, GeoPosCommand as u, GeoSearchCommand as v, GeoSearchStoreCommand as w, GetCommand as x, GetBitCommand as y, GetDelCommand as z };
+export { HStrLenCommand as $, AppendCommand as A, BitCountCommand as B, CopyCommand as C, DBSizeCommand as D, EchoCommand as E, FlushAllCommand as F, GeoAddCommand as G, GetExCommand as H, GetRangeCommand as I, GetSetCommand as J, HDelCommand as K, HExistsCommand as L, HGetCommand as M, HGetAllCommand as N, HIncrByCommand as O, Pipeline as P, HIncrByFloatCommand as Q, type RedisOptions as R, HKeysCommand as S, HLenCommand as T, type UpstashRequest as U, HMGetCommand as V, HMSetCommand as W, HRandFieldCommand as X, HScanCommand as Y, HSetCommand as Z, HSetNXCommand as _, type RequesterConfig as a, type SetCommandOptions as a$, HValsCommand as a0, IncrCommand as a1, IncrByCommand as a2, IncrByFloatCommand as a3, JsonArrAppendCommand as a4, JsonArrIndexCommand as a5, JsonArrInsertCommand as a6, JsonArrLenCommand as a7, JsonArrPopCommand as a8, JsonArrTrimCommand as a9, LTrimCommand as aA, MGetCommand as aB, MSetCommand as aC, MSetNXCommand as aD, PersistCommand as aE, PExpireCommand as aF, PExpireAtCommand as aG, PingCommand as aH, PSetEXCommand as aI, PTtlCommand as aJ, PublishCommand as aK, RandomKeyCommand as aL, RenameCommand as aM, RenameNXCommand as aN, RPopCommand as aO, RPushCommand as aP, RPushXCommand as aQ, SAddCommand as aR, ScanCommand as aS, type ScanCommandOptions as aT, SCardCommand as aU, ScriptExistsCommand as aV, ScriptFlushCommand as aW, ScriptLoadCommand as aX, SDiffCommand as aY, SDiffStoreCommand as aZ, SetCommand as a_, JsonClearCommand as aa, JsonDelCommand as ab, JsonForgetCommand as ac, JsonGetCommand as ad, JsonMGetCommand as ae, JsonNumIncrByCommand as af, JsonNumMultByCommand as ag, JsonObjKeysCommand as ah, JsonObjLenCommand as ai, JsonRespCommand as aj, JsonSetCommand as ak, JsonStrAppendCommand as al, JsonStrLenCommand as am, JsonToggleCommand as an, JsonTypeCommand as ao, KeysCommand as ap, LIndexCommand as aq, LInsertCommand as ar, LLenCommand as as, LMoveCommand as at, LPopCommand as au, LPushCommand as av, LPushXCommand as aw, LRangeCommand as ax, LRemCommand as ay, LSetCommand as az, Redis as b, SetBitCommand as b0, SetExCommand as b1, SetNxCommand as b2, SetRangeCommand as b3, SInterCommand as b4, SInterStoreCommand as b5, SIsMemberCommand as b6, SMembersCommand as b7, SMIsMemberCommand as b8, SMoveCommand as b9, ZPopMaxCommand as bA, ZPopMinCommand as bB, ZRangeCommand as bC, type ZRangeCommandOptions as bD, ZRankCommand as bE, ZRemCommand as bF, ZRemRangeByLexCommand as bG, ZRemRangeByRankCommand as bH, ZRemRangeByScoreCommand as bI, ZRevRankCommand as bJ, ZScanCommand as bK, ZScoreCommand as bL, ZUnionCommand as bM, type ZUnionCommandOptions as bN, ZUnionStoreCommand as bO, type ZUnionStoreCommandOptions as bP, SPopCommand as ba, SRandMemberCommand as bb, SRemCommand as bc, SScanCommand as bd, StrLenCommand as be, SUnionCommand as bf, SUnionStoreCommand as bg, TimeCommand as bh, TouchCommand as bi, TtlCommand as bj, type Type as bk, TypeCommand as bl, UnlinkCommand as bm, XAddCommand as bn, XRangeCommand as bo, type ScoreMember as bp, type ZAddCommandOptions as bq, ZAddCommand as br, ZCardCommand as bs, ZCountCommand as bt, ZDiffStoreCommand as bu, ZIncrByCommand as bv, ZInterStoreCommand as bw, type ZInterStoreCommandOptions as bx, ZLexCountCommand as by, ZMScoreCommand as bz, type UpstashResponse as c, type Requester as d, error as e, BitOpCommand as f, BitPosCommand as g, DecrCommand as h, DecrByCommand as i, DelCommand as j, EvalCommand as k, EvalshaCommand as l, ExistsCommand as m, ExpireCommand as n, ExpireAtCommand as o, FlushDBCommand as p, type GeoAddCommandOptions as q, type GeoMember as r, GeoDistCommand as s, GeoHashCommand as t, GeoPosCommand as u, GeoSearchCommand as v, GeoSearchStoreCommand as w, GetCommand as x, GetBitCommand as y, GetDelCommand as z };