Interface ScheduledTask

src/tasks/scheduled-task.ts:135–168

 * Represents a scheduled task that can be managed and executed.
 */
export interface ScheduledTask {
  id: string,
  name?: string,
  
  start(): void | Promise<void>;
  stop(): void | Promise<void>;
  getStatus(): string;
  destroy(): void | Promise<void>;
  execute(): Promise<any>;
  getNextRun(): Date | null;

  /** The next `count` instants this task's expression matches, from now. */
  getNextRuns(count: number): Date[];
  /** Whether the given date matches this task's expression. */
  match(date: Date): boolean;
  /** Milliseconds until the next run, or `null` when the task is stopped. */
  msToNext(): number | null;
  /** Whether an execution is currently in progress. */
  isBusy(): boolean;
  /** Remaining executions when `maxExecutions` is set, otherwise `undefined`. */
  runsLeft(): number | undefined;
  /** The original cron expression. */
  getPattern(): string;
  /**
   * Information about the last actual execution, or `null` if the task has not
   * run yet. `date` reflects when the execution really ran, not when a tick was
   * checked.
   */
  lastRun(): LastRun | null;

  on(event: TaskEvent, fun: (context: TaskContext) => Promise<void> | void): void
  off(event: TaskEvent, fun: (context: TaskContext) => Promise<void> | void): void
  once(event: TaskEvent, fun: (context: TaskContext) => Promise<void> | void): void 
}