sidekiq-ts 1.0.0

package/dist/api.d.ts

@@ -0,0 +1,172 @@
+import type { Config } from "./config.js";
+import type { JobPayload } from "./types.js";
+export declare class Stats {
+    private readonly config?;
+    constructor(config?: Config);
+    processed(): Promise<number>;
+    failed(): Promise<number>;
+    workersSize(): Promise<number>;
+    scheduledSize(): Promise<number>;
+    retrySize(): Promise<number>;
+    deadSize(): Promise<number>;
+    processesSize(): Promise<number>;
+    enqueued(): Promise<number>;
+    defaultQueueLatency(): Promise<number>;
+    reset(...stats: Array<string | number | symbol>): Promise<void>;
+    queues(): Promise<Record<string, number>>;
+}
+export declare class StatsHistory {
+    private readonly config?;
+    private readonly daysPrevious;
+    private readonly startDate;
+    constructor(daysPrevious: number, startDate?: Date, config?: Config);
+    processed(): Promise<Record<string, number>>;
+    failed(): Promise<Record<string, number>>;
+    private dateStat;
+}
+export declare class Queue {
+    private readonly config?;
+    readonly name: string;
+    constructor(name?: string, config?: Config);
+    static all(config?: Config): Promise<Queue[]>;
+    size(): Promise<number>;
+    clear(): Promise<void>;
+    entries(start?: number, stop?: number): Promise<JobPayload[]>;
+    latency(): Promise<number>;
+    each(pageSize?: number): AsyncGenerator<JobRecord>;
+    findJob(jid: string): Promise<JobRecord | null>;
+}
+export declare class JobRecord {
+    readonly queue: string;
+    readonly value: string;
+    readonly payload: JobPayload;
+    private readonly config?;
+    constructor(value: string, queue: string, config?: Config);
+    get jid(): string | undefined;
+    delete(): Promise<boolean>;
+}
+declare class SortedSet {
+    protected config?: Config;
+    protected key: string;
+    constructor(key: string, config?: Config);
+    size(): Promise<number>;
+    clear(): Promise<void>;
+}
+export declare class SortedEntry {
+    readonly score: number;
+    readonly payload: JobPayload;
+    readonly value: string;
+    private readonly parent;
+    constructor(parent: JobSet, score: number, value: string);
+    get jid(): string | undefined;
+    delete(): Promise<void>;
+    reschedule(at: number): Promise<void>;
+    addToQueue(): Promise<void>;
+    retry(): Promise<void>;
+    kill(): Promise<void>;
+}
+declare class JobSet extends SortedSet {
+    entries(start?: number, stop?: number): Promise<SortedEntry[]>;
+    scan(match: string, count?: number): AsyncGenerator<SortedEntry>;
+    each(): AsyncGenerator<SortedEntry>;
+    findJob(jid: string): Promise<SortedEntry | null>;
+    schedule(timestamp: number, payload: JobPayload): Promise<void>;
+    retryAll(): Promise<void>;
+    killAll(): Promise<void>;
+    deleteByValue(value: string): Promise<void>;
+    rescheduleValue(value: string, at: number): Promise<void>;
+    addToQueueValue(value: string): Promise<void>;
+    retryValue(value: string): Promise<void>;
+    killValue(value: string): Promise<void>;
+    private popEach;
+}
+export declare class ScheduledSet extends JobSet {
+    constructor(config?: Config);
+}
+export declare class RetrySet extends JobSet {
+    constructor(config?: Config);
+}
+export declare class DeadSet extends JobSet {
+    constructor(config?: Config);
+    kill(payload: string | JobPayload, options?: {
+        trim?: boolean;
+    }): Promise<void>;
+    trim(): Promise<void>;
+}
+export interface ProcessInfoEntry {
+    identity: string;
+    info: Record<string, unknown>;
+    busy: number;
+    beat: number;
+    quiet: boolean;
+    rtt_us: number;
+    rss: number;
+}
+export declare class ProcessSet {
+    private readonly config?;
+    constructor(config?: Config);
+    static get(identity: string, config?: Config): Promise<ProcessInfoEntry | null>;
+    entries(): Promise<ProcessInfoEntry[]>;
+    size(): Promise<number>;
+    totalConcurrency(): Promise<number>;
+    totalRss(): Promise<number>;
+    cleanup(): Promise<number>;
+}
+/**
+ * Represents a single Sidekiq process and allows remote signaling.
+ */
+export declare class Process {
+    private readonly config?;
+    readonly identity: string;
+    readonly info: Record<string, unknown>;
+    readonly busy: number;
+    readonly beat: number;
+    readonly quiet: boolean;
+    readonly rtt_us: number;
+    readonly rss: number;
+    constructor(entry: ProcessInfoEntry, config?: Config);
+    get tag(): string | undefined;
+    get labels(): string[];
+    get queues(): string[];
+    get version(): string | undefined;
+    get embedded(): boolean;
+    /**
+     * Whether this process is quiet or shutting down.
+     */
+    get stopping(): boolean;
+    /**
+     * Signal this process to stop processing new jobs.
+     * It will continue to execute jobs it has already fetched.
+     * This method is asynchronous and it can take 5-10 seconds
+     * for the process to quiet.
+     */
+    quietProcess(): Promise<void>;
+    /**
+     * Signal this process to shutdown.
+     * It will shutdown within its configured timeout value, default 25 seconds.
+     * This method is asynchronous and it can take 5-10 seconds
+     * for the process to start shutting down.
+     */
+    stopProcess(): Promise<void>;
+    /**
+     * Signal this process to log its current worker state.
+     * Useful for debugging frozen or deadlocked processes.
+     * This method is asynchronous and it can take 5-10 seconds.
+     */
+    dumpThreads(): Promise<void>;
+    private signal;
+}
+export interface WorkerEntry {
+    process: string;
+    thread: string;
+    queue: string;
+    payload: JobPayload;
+    run_at: number;
+}
+export declare class Workers {
+    private readonly config?;
+    constructor(config?: Config);
+    entries(): Promise<WorkerEntry[]>;
+}
+export {};
+//# sourceMappingURL=api.d.ts.map

package/dist/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAI1C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAK7C,qBAAa,KAAK;IAChB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAS;gBAErB,MAAM,CAAC,EAAE,MAAM;IAIrB,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;IAK5B,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC;IAKzB,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC;IAc9B,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAKhC,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;IAK5B,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC;IAK3B,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAKhC,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC;IAc3B,mBAAmB,IAAI,OAAO,CAAC,MAAM,CAAC;IAgCtC,KAAK,CAAC,GAAG,KAAK,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAiB/D,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAkBhD;AAED,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAO;gBAG/B,YAAY,EAAE,MAAM,EACpB,SAAS,GAAE,IAAiB,EAC5B,MAAM,CAAC,EAAE,MAAM;IAgBjB,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAI5C,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAI3B,QAAQ;CAkBvB;AAED,qBAAa,KAAK;IAChB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAS;IACjC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;gBAEV,IAAI,SAAY,EAAE,MAAM,CAAC,EAAE,MAAM;WAKhC,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAM7C,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC;IAKvB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAQtB,OAAO,CAAC,KAAK,SAAI,EAAE,IAAI,SAAK,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAMpD,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC;IA+BzB,IAAI,CAAC,QAAQ,SAAK,GAAG,cAAc,CAAC,SAAS,CAAC;IAqB/C,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;CAQtD;AAED,qBAAa,SAAS;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAC7B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAS;gBAErB,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;IAOzD,IAAI,GAAG,IAAI,MAAM,GAAG,SAAS,CAE5B;IAEK,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;CAKjC;AAED,cAAM,SAAS;IACb,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAC1B,SAAS,CAAC,GAAG,EAAE,MAAM,CAAC;gBAEV,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;IAKlC,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC;IAKvB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAI7B;AAED,qBAAa,WAAW;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAC7B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;gBAEpB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAOxD,IAAI,GAAG,IAAI,MAAM,GAAG,SAAS,CAE5B;IAEK,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAIvB,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrC,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAI3B,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAItB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAG5B;AAED,cAAM,MAAO,SAAQ,SAAS;IACtB,OAAO,CAAC,KAAK,SAAI,EAAE,IAAI,SAAK,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAkBpD,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,SAAM,GAAG,cAAc,CAAC,WAAW,CAAC;IAyB7D,IAAI,IAAI,cAAc,CAAC,WAAW,CAAC;IAIpC,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IASjD,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAO/D,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAWzB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAQxB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAK3C,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAKzD,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAW7C,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAcxC,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;YAU/B,OAAO;CAetB;AAED,qBAAa,YAAa,SAAQ,MAAM;gBAC1B,MAAM,CAAC,EAAE,MAAM;CAG5B;AAED,qBAAa,QAAS,SAAQ,MAAM;gBACtB,MAAM,CAAC,EAAE,MAAM;CAG5B;AAED,qBAAa,OAAQ,SAAQ,MAAM;gBACrB,MAAM,CAAC,EAAE,MAAM;IAIrB,IAAI,CACR,OAAO,EAAE,MAAM,GAAG,UAAU,EAC5B,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,OAAO,CAAA;KAAO,GAC/B,OAAO,CAAC,IAAI,CAAC;IAUV,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAa5B;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;CACb;AAED,qBAAa,UAAU;IACrB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAS;gBAErB,MAAM,CAAC,EAAE,MAAM;WAId,GAAG,CACd,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAyB7B,OAAO,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;IA4BtC,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC;IAKvB,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;IAQnC,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC;IAK3B,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC;CAsBjC;AAED;;GAEG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAS;IACjC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;gBAET,KAAK,EAAE,gBAAgB,EAAE,MAAM,CAAC,EAAE,MAAM;IAWpD,IAAI,GAAG,IAAI,MAAM,GAAG,SAAS,CAE5B;IAED,IAAI,MAAM,IAAI,MAAM,EAAE,CAErB;IAED,IAAI,MAAM,IAAI,MAAM,EAAE,CAErB;IAED,IAAI,OAAO,IAAI,MAAM,GAAG,SAAS,CAEhC;IAED,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED;;;;;OAKG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAOnC;;;;;OAKG;IACG,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAOlC;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;YAIpB,MAAM;CAQrB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,UAAU,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,qBAAa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAS;gBAErB,MAAM,CAAC,EAAE,MAAM;IAIrB,OAAO,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;CAgCxC"}