@rocket.chat/apps-engine/definition/scheduler/IProcessor.d.ts

The engine code for the Rocket.Chat Apps which manages, runs, translates, coordinates and all of that.

import type { IHttp, IModify, IPersistence, IRead } from '../accessors';
/** Represents a processor that is used by the scheduler methods */
export interface IProcessor {
    /** The processor's identifier */
    id: string;
    /** If provided, the processor will be configured with the setting as soon as it gets registered */
    startupSetting?: StartupSetting;
    /** The function that will be run on a given scheudle */
    processor(jobContext: IJobContext, read: IRead, modify: IModify, http: IHttp, persis: IPersistence): Promise<void>;
}
/** The `data` object provided to the processor during the registering process */
export interface IJobContext {
    [key: string]: any;
}
type StartupSetting = IOnetimeStartup | IRecurringStartup;
/**
 * Processor setting for running once after being registered
 */
export interface IOnetimeStartup {
    type: StartupType.ONETIME;
    when: string | Date;
    data?: object;
}
/**
 * Processor setting for running recurringly after being registered
 */
export interface IRecurringStartup {
    type: StartupType.RECURRING;
    interval: string | number;
    skipImmediate?: boolean;
    data?: object;
}
/**
 * Jobs' startup types
 */
export declare enum StartupType {
    ONETIME = "onetime",
    RECURRING = "recurring"
}
export {};