@botmesh/core - v2.0.0-alpha.2
    Preparing search index...

    Interface ScheduledTask

    interface ScheduledTask {
        id: string;
        cron?: string;
        interval?: string | number;
        runAt?: Date;
        nextRun: Date | null;
        isRecurring: boolean;
        durable?: boolean;
        timeZone?: string;
        cancel(): void;
    }
    Index
    id cron? interval? runAt? nextRun isRecurring durable? timeZone?
    cancel
    id: string
    cron?: string
    interval?: string | number
    runAt?: Date
    nextRun: Date | null
    isRecurring: boolean
    durable?: boolean

    true for a durable task (registered with DurableTaskOptions): its schedule lives in a ScheduleStore, and cancel() also deletes the stored row. Absent on in-memory tasks.

    timeZone?: string

    The IANA zone a cron task's fields are read in (CronTaskOptions.timeZone, DurableTaskOptions.timeZone or SchedulerOptions.timeZone). Absent when they are read in the process zone, and on interval and one-shot tasks.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods