@pingpolls/redisq 1.0.0 → 1.0.2

package/dist/app.d.ts

@@ -0,0 +1,92 @@
+import { RedisClient as BunRedisClient } from "bun";
+export type QueueOptions = {
+    redis: BunRedisClient;
+} | {
+    host: string;
+    port: string;
+    user?: string;
+    password?: string;
+    namespace?: string;
+    tls?: boolean;
+};
+export type CreateQueueOptions<QueueName extends string = string> = QueueName extends `${string}:batch` ? {
+    qname: QueueName;
+    maxsize?: number;
+    maxRetries?: number;
+    maxBackoffSeconds?: number;
+    every?: number;
+} : {
+    qname: QueueName;
+    maxsize?: number;
+    maxRetries?: number;
+    maxBackoffSeconds?: number;
+};
+export interface QueueAttributes {
+    maxsize: number;
+    created: number;
+    msgs: number;
+    isBatch: boolean;
+    maxRetries: number;
+    maxBackoffSeconds: number;
+    every?: number;
+}
+export interface SendMessageOptions {
+    qname: string;
+    message: string;
+    delay?: number;
+}
+export interface SendBatchMessageOptions {
+    qname: string;
+    batchId: string;
+    message: string;
+}
+export interface Message {
+    id: string;
+    message: string;
+    sent: number;
+    attempt: number;
+}
+export interface BatchMessage {
+    batchId: string;
+    messages: Omit<Message, "attempt">[];
+    sent: number;
+    attempt: number;
+}
+export declare class RedisQ {
+    private redis;
+    private redisUrl;
+    private ns;
+    private workers;
+    private batchJobs;
+    private isClosing;
+    constructor(options: QueueOptions);
+    private getKey;
+    private isBatchQueue;
+    createQueue<QueueName extends string>(options: CreateQueueOptions<QueueName>): Promise<boolean>;
+    listQueues(): Promise<string[]>;
+    getQueue(qname: string): Promise<QueueAttributes | null>;
+    deleteQueue(qname: string): Promise<boolean>;
+    sendMessage(options: SendMessageOptions): Promise<string>;
+    sendBatchMessage(options: SendBatchMessageOptions): Promise<string>;
+    private encodeMessage;
+    private decodeMessage;
+    private encodeBatchMeta;
+    private decodeBatchMeta;
+    private fetchMessages;
+    private fetchBatchMessage;
+    deleteMessage(qname: string, id: string): Promise<boolean>;
+    private deleteBatch;
+    private retryMessage;
+    private retryBatch;
+    private processDelayedMessages;
+    private processBatches;
+    startWorker<QueueName extends `${string}:batch` | (string & {})>(qname: QueueName, handler: (received: QueueName extends `${string}:batch` ? BatchMessage : Message) => Promise<{
+        success: boolean;
+    }>, options?: {
+        concurrency?: number;
+        silent?: boolean;
+    }): Promise<void>;
+    private runWorker;
+    stopWorker(qname: string): void;
+    close(): Promise<void>;
+}