A one-shot read of a managed process's runtime mirror — the observable state the supervisor maintains as it reconciles the schedule and spawns instances. Native (engine-side) types; the toolkit contract (processStatus) maps these to its wire form.
export interface ProcessSnapshot {
/** Whether the schedule currently places the process in a run window (derived from entries). */
readonly ProcessSnapshot.armed: booleanWhether the schedule currently places the process in a run window (derived from entries).
armed: boolean;
/** How many run instances are executing right now. */
readonly ProcessSnapshot.activeInstances: numberHow many run instances are executing right now.
activeInstances: number;
/** When the next run instance is expected to start (none if disarmed/idle). */
readonly ProcessSnapshot.nextTriggerRun: Option.Option<Date>When the next run instance is expected to start (none if disarmed/idle).
nextTriggerRun: import OptionOption.type Option<A> = Option.None<A> | Option.Some<A>The Option data type represents optional values. An Option<A> is either
Some<A>, containing a value of type A, or None, representing absence.
When to use
Use to represent initial values that may not yet exist
- Returning from partial functions (not defined for all inputs)
- Managing optional fields in data structures
Namespace containing utility types for Option.
When to use
Use to access type-level helpers associated with Option.
Option<Date>;
/** When the schedule next changes armed/disarmed (none if no future transition). */
readonly ProcessSnapshot.nextScheduleTransition: Option.Option<Date>When the schedule next changes armed/disarmed (none if no future transition).
nextScheduleTransition: import OptionOption.type Option<A> = Option.None<A> | Option.Some<A>The Option data type represents optional values. An Option<A> is either
Some<A>, containing a value of type A, or None, representing absence.
When to use
Use to represent initial values that may not yet exist
- Returning from partial functions (not defined for all inputs)
- Managing optional fields in data structures
Namespace containing utility types for Option.
When to use
Use to access type-level helpers associated with Option.
Option<Date>;
/** The in-instance repeat cadence, when polling is configured (none otherwise). */
readonly ProcessSnapshot.nextPollCadence: Option.Option<Duration.Duration>The in-instance repeat cadence, when polling is configured (none otherwise).
nextPollCadence: import OptionOption.type Option<A> = Option.None<A> | Option.Some<A>The Option data type represents optional values. An Option<A> is either
Some<A>, containing a value of type A, or None, representing absence.
When to use
Use to represent initial values that may not yet exist
- Returning from partial functions (not defined for all inputs)
- Managing optional fields in data structures
Namespace containing utility types for Option.
When to use
Use to access type-level helpers associated with Option.
Option<import DurationDuration.Duration>;
/** Total effect runs started (scheduled + polling + manual {@link run}) since the layer built. */
readonly ProcessSnapshot.runsStarted: numberTotal effect runs started (scheduled + polling + manual
run
) since the layer built.
runsStarted: number;
/** Of those, how many completed successfully. */
readonly ProcessSnapshot.runsSucceeded: numberOf those, how many completed successfully.
runsSucceeded: number;
/** Of those, how many failed. */
readonly ProcessSnapshot.runsFailed: numberOf those, how many failed.
runsFailed: number;
/** When the most recent run started (none if it hasn't run yet). */
readonly ProcessSnapshot.lastRunStartedAt: Option.Option<Date>When the most recent run started (none if it hasn't run yet).
lastRunStartedAt: import OptionOption.type Option<A> = Option.None<A> | Option.Some<A>The Option data type represents optional values. An Option<A> is either
Some<A>, containing a value of type A, or None, representing absence.
When to use
Use to represent initial values that may not yet exist
- Returning from partial functions (not defined for all inputs)
- Managing optional fields in data structures
Namespace containing utility types for Option.
When to use
Use to access type-level helpers associated with Option.
Option<Date>;
/** Wall-clock duration of the most recent finished run, in ms (none if none finished). */
readonly ProcessSnapshot.lastRunDurationMillis: Option.Option<number>Wall-clock duration of the most recent finished run, in ms (none if none finished).
lastRunDurationMillis: import OptionOption.type Option<A> = Option.None<A> | Option.Some<A>The Option data type represents optional values. An Option<A> is either
Some<A>, containing a value of type A, or None, representing absence.
When to use
Use to represent initial values that may not yet exist
- Returning from partial functions (not defined for all inputs)
- Managing optional fields in data structures
Namespace containing utility types for Option.
When to use
Use to access type-level helpers associated with Option.
Option<number>;
}