@upstash/redis 1.34.4 → 1.34.6

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

@@ -36,7 +36,23 @@ type UpstashRequest = {
      * Request body will be serialized to json
      */
     body?: unknown;
+    /**
+     * Additional headers for the request
+     */
+    headers?: Record<string, string>;
     upstashSyncToken?: string;
+    /**
+     * Callback for handling streaming messages
+     */
+    onMessage?: (data: string) => void;
+    /**
+     * Whether this request expects a streaming response
+     */
+    isStreaming?: boolean;
+    /**
+     * Abort signal for the request
+     */
+    signal?: AbortSignal;
 };
 type UpstashResponse<TResult> = {
     result?: TResult;
@@ -119,6 +135,31 @@ type CommandOptions<TResult, TData> = {
      */
     automaticDeserialization?: boolean;
     latencyLogging?: boolean;
+    /**
+     * Additional headers to be sent with the request
+     */
+    headers?: Record<string, string>;
+    /**
+     * Path to append to the URL
+     */
+    path?: string[];
+    /**
+     * Options for streaming requests, mainly used for subscribe, monitor commands
+     **/
+    streamOptions?: {
+        /**
+         * Callback to be called when a message is received
+         */
+        onMessage?: (data: string) => void;
+        /**
+         * Whether the request is streaming
+         */
+        isStreaming?: boolean;
+        /**
+         * Signal to abort the request
+         */
+        signal?: AbortSignal;
+    };
 };
 /**
  * Command offers default (de)serialization and the exec method to all commands.
@@ -130,6 +171,11 @@ declare class Command<TResult, TData> {
     readonly command: (string | number | boolean)[];
     readonly serialize: Serialize;
     readonly deserialize: Deserialize<TResult, TData>;
+    protected readonly headers?: Record<string, string>;
+    protected readonly path?: string[];
+    protected readonly onMessage?: (data: string) => void;
+    protected readonly isStreaming: boolean;
+    protected readonly signal?: AbortSignal;
     /**
      * Create a new command instance.
      *
@@ -1643,6 +1689,42 @@ declare class ZScoreCommand<TData> extends Command<string | null, number | null>
     constructor(cmd: [key: string, member: TData], opts?: CommandOptions<string | null, number | null>);
 }
 
+type BaseMessageData<TMessage> = {
+    channel: string;
+    message: TMessage;
+};
+type PatternMessageData<TMessage> = BaseMessageData<TMessage> & {
+    pattern: string;
+};
+type SubscriptionCountEvent = number;
+type MessageEventMap<TMessage> = {
+    message: BaseMessageData<TMessage>;
+    subscribe: SubscriptionCountEvent;
+    unsubscribe: SubscriptionCountEvent;
+    pmessage: PatternMessageData<TMessage>;
+    psubscribe: SubscriptionCountEvent;
+    punsubscribe: SubscriptionCountEvent;
+    error: Error;
+    [key: `message:${string}`]: BaseMessageData<TMessage>;
+    [key: `pmessage:${string}`]: PatternMessageData<TMessage>;
+};
+type EventType = keyof MessageEventMap<any>;
+type Listener<TMessage, T extends EventType> = (event: MessageEventMap<TMessage>[T]) => void;
+declare class Subscriber<TMessage = any> extends EventTarget {
+    private subscriptions;
+    private client;
+    private listeners;
+    constructor(client: Requester, channels: string[], isPattern?: boolean);
+    private subscribeToChannel;
+    private subscribeToPattern;
+    private handleMessage;
+    private dispatchToListeners;
+    on<T extends keyof MessageEventMap<TMessage>>(type: T, listener: Listener<TMessage, T>): void;
+    removeAllListeners(): void;
+    unsubscribe(channels?: string[]): Promise<void>;
+    getSubscribedChannels(): string[];
+}
+
 type InferResponseData<T extends unknown[]> = {
     [K in keyof T]: T[K] extends Command<any, infer TData> ? TData : unknown;
 };
@@ -3236,6 +3318,10 @@ declare class Redis {
      * @see https://redis.io/commands/psetex
      */
     psetex: <TData>(key: string, ttl: number, value: TData) => Promise<string>;
+    /**
+     * @see https://redis.io/commands/psubscribe
+     */
+    psubscribe: <TMessage>(patterns: string | string[]) => Subscriber<TMessage>;
     /**
      * @see https://redis.io/commands/pttl
      */
@@ -3364,6 +3450,10 @@ declare class Redis {
      * @see https://redis.io/commands/strlen
      */
     strlen: (key: string) => Promise<number>;
+    /**
+     * @see https://redis.io/commands/subscribe
+     */
+    subscribe: <TMessage>(channels: string | string[]) => Subscriber<TMessage>;
     /**
      * @see https://redis.io/commands/sunion
      */