Interface ScheduledJob

Scheduled job configuration

interface ScheduledJob {
    id: string;
    cron?: string;
    intervalMs?: number;
    runner: EnhancedRunner<any, any>;
    userId: string;
    sessionId?: string;
    input: string | Content;
    enabled?: boolean;
    maxExecutions?: number;
    onTrigger?: ((jobId: string) => void);
    onComplete?: ((jobId: string, events: Event[]) => void);
    onError?: ((jobId: string, error: Error) => void);
    onEvent?: ((jobId: string, event: Event) => void);
}

Properties

id cron? intervalMs? runner userId sessionId? input enabled? maxExecutions? onTrigger? onComplete? onError? onEvent?

Properties

id

id: string

Unique identifier for this job

Optionalcron

cron?: string

Cron expression (e.g., "0 9 * * *" for daily at 9 AM)

OptionalintervalMs

intervalMs?: number

Interval in milliseconds (alternative to cron)

runner

runner: EnhancedRunner<any, any>

The runner to execute

userId

userId: string

User ID for the session

OptionalsessionId

sessionId?: string

Session ID (optional - creates new session each run if not provided)

input

input: string | Content

Input message to send on each scheduled run

Optionalenabled

enabled?: boolean

Whether the job is enabled (default: true)

OptionalmaxExecutions

maxExecutions?: number

Maximum number of executions (undefined = unlimited)

OptionalonTrigger

onTrigger?: ((jobId: string) => void)

Callback when job triggers

OptionalonComplete

onComplete?: ((jobId: string, events: Event[]) => void)

Callback when execution completes

OptionalonError

onError?: ((jobId: string, error: Error) => void)

Callback on execution error

OptionalonEvent

onEvent?: ((jobId: string, event: Event) => void)

Callback for each event as it streams in during execution

Settings

Member Visibility

On This Page

Properties