@usine/engine/loop-control
Classes
Section titled “Classes”LoopControl
Section titled “LoopControl”Records whether triggers may open new Runs for each Loop; existing Runs and authored files stay unchanged.
Extends
Section titled “Extends”Context.ServiceClass
Properties
Section titled “Properties”Service
Section titled “Service”
readonlyService:object
The service’s operations: what yield* LoopControl returns.
isPaused
Section titled “isPaused”
readonlyisPaused: (loop) =>Effect.Effect<boolean,EnginePersistenceError>
Whether new Runs are paused; a Loop with no recorded runtime state is unpaused.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
loop |
LoopName |
Returns
Section titled “Returns”Effect.Effect<boolean, EnginePersistenceError>
readonlypause: (loop) =>Effect.Effect<LoopRuntimeState,EnginePersistenceError>
Pauses new trigger work for this Loop without stopping its existing Runs.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
loop |
LoopName |
Returns
Section titled “Returns”Effect.Effect<LoopRuntimeState, EnginePersistenceError>
states
Section titled “states”
readonlystates:Effect.Effect<ReadonlyArray<LoopRuntimeState>,EnginePersistenceError>
Recorded runtime states ordered by Loop name; Loops without stored state are omitted.
unpause
Section titled “unpause”
readonlyunpause: (loop) =>Effect.Effect<LoopRuntimeState,EnginePersistenceError>
Allows triggers to open new Runs for this Loop again.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
loop |
LoopName |
Returns
Section titled “Returns”Effect.Effect<LoopRuntimeState, EnginePersistenceError>
readonlystaticlayer:Layer<LoopControl,never,RunDatabase>
LoopRuntimeState
Section titled “LoopRuntimeState”Runtime state for one Loop. Authored loop files never carry this toggle.
Extends
Section titled “Extends”Schema.Class
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new LoopRuntimeState(…
args):LoopRuntimeState
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
…args |
[props: object, options?: MakeOptions] |
Returns
Section titled “Returns”Properties
Section titled “Properties”
readonlyloop:string&Brand<"LoopName">
paused
Section titled “paused”
readonlypaused:boolean