Interface RoutineRunContext

What one routine's execution needs from its caller. The sweep passes its full ScheduledJobExecutionContext; a manual run (UserRoutineDispatcherDriver.RunRoutineNow) passes only these.

interface RoutineRunContext {
    BypassWakeGate?: boolean;
    ContextUser: UserInfo;
    heartbeat?: () => Promise<void>;
}

Index

Properties

BypassWakeGate? ContextUser heartbeat?

Properties

`Optional`BypassWakeGate

BypassWakeGate?: boolean

True for a run the user asked for by hand: the wake gate is not consulted.

ContextUser

ContextUser: UserInfo

The bookkeeping user: run rows and routine roll-up are saved as this user (the scheduler's system user).

`Optional`heartbeat

heartbeat?: () => Promise<void>