@chromahq/core 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,109 @@
+export { inject as Inject } from 'inversify';
+
+declare const METADATA_KEY: {
+    PARAM_TYPES: string;
+    TYPE: string;
+    RETURN_TYPE: string;
+};
+declare const container: any;
+declare const bind: <T>(id: symbol | (new (...a: any[]) => T), cls: new (...a: any[]) => T) => any;
+declare const resolve: <T>(id: symbol | (new (...a: any[]) => T)) => T;
+declare function isInjectable(target: any): boolean;
+
+declare function create(): Promise<void>;
+
+declare abstract class IMessage {
+    handle(...args: any[]): Promise<void> | void;
+}
+declare function Message(name: string): (constructor: any) => any;
+
+declare function Injectable(): (constructor: new (...args: any[]) => any) => void;
+
+declare abstract class Booteable {
+    /**
+     * Boot method to be called when the service is initialized.
+     * This method can be used to perform any setup or initialization logic.
+     */
+    abstract boot(): void;
+    /**
+     * Optional destroy method to be called when the service is being destroyed.
+     * This can be used to clean up resources or perform any necessary teardown logic.
+     */
+    destroy?(): void;
+}
+declare function isBooteable(obj: any): obj is Booteable;
+declare function isDestroyable(obj: any): obj is Booteable;
+
+interface JobOptions {
+    id?: string;
+    delay?: number;
+    cron?: string;
+    persistent?: boolean;
+}
+
+interface IJob<T = unknown> {
+    readonly data?: T;
+    handle(context?: JobContext): Promise<void> | void;
+    pause?(): Promise<void> | void;
+    resume?(): Promise<void> | void;
+    stop?(): Promise<void> | void;
+}
+declare enum JobState {
+    SCHEDULED = "scheduled",
+    RUNNING = "running",
+    PAUSED = "paused",
+    STOPPED = "stopped",
+    COMPLETED = "completed",
+    FAILED = "failed"
+}
+interface JobContext {
+    id: string;
+    options?: JobOptions;
+    state: JobState;
+    createdAt: Date;
+    updatedAt: Date;
+    startedAt?: Date;
+    pausedAt?: Date;
+    stoppedAt?: Date;
+    completedAt?: Date;
+    error?: Error;
+    retryCount?: number;
+    /**
+     *  Pause the job execution.
+     * @returns Promise<void> | void
+     */
+    pause: () => Promise<void> | void;
+    resume: () => Promise<void> | void;
+    stop: () => Promise<void> | void;
+    complete: () => Promise<void> | void;
+    fail: (error: Error) => Promise<void> | void;
+    retry: () => Promise<void> | void;
+    isRunning: () => boolean;
+    isPaused: () => boolean;
+    isStopped: () => boolean;
+    isCompleted: () => boolean;
+    isFailed: () => boolean;
+    isRetrying: () => boolean;
+    isScheduled: () => boolean;
+    isDelayed: () => boolean;
+    isRecurring: () => boolean;
+    isCron: () => boolean;
+    isTimeout: () => boolean;
+    isAlarm: () => boolean;
+}
+
+declare abstract class Job<T = unknown> implements IJob<T> {
+    readonly data?: T | undefined;
+    constructor(data?: T | undefined);
+    abstract handle(context?: JobContext): Promise<void> | void;
+    pause?(): Promise<void> | void;
+    resume?(): Promise<void> | void;
+    stop?(): Promise<void> | void;
+}
+
+declare const Delay: (ms: number) => (constructor: any) => any;
+
+declare function Every(cron: string): (constructor: any) => any;
+
+export { Booteable, Delay, Every, IMessage, Injectable, Job, JobState, METADATA_KEY, Message, bind, container, create, isBooteable, isDestroyable, isInjectable, resolve };
+export type { IJob, JobContext };