ProcessOptions
Defined in: Process.ts:46
Options for creating a Process.
Properties
Section titled “Properties”duration?
Section titled “duration?”
optionalduration?:number
Defined in: Process.ts:66
Auto-complete after this duration in seconds. Finite and > 0.
optionalloop?:boolean
Defined in: Process.ts:68
Loop the process.
onCancel?
Section titled “onCancel?”
optionalonCancel?: () =>void
Defined in: Process.ts:57
Called when cancel() stops the process before it completed. A process
that owns other processes cancels them here, so cancelling the owner
reaches everything it started.
Returns
Section titled “Returns”void
onComplete?
Section titled “onComplete?”
optionalonComplete?: () =>void
Defined in: Process.ts:51
Called when the process completes.
Returns
Section titled “Returns”void
onReset?
Section titled “onReset?”
optionalonReset?: () =>void
Defined in: Process.ts:64
Called when the process is reset for a re-run — what a Sequence does to
a step instance on each loop or repeat iteration. Elapsed time and
completion are reset for you; clear any state the process keeps of its
own here.
Returns
Section titled “Returns”void
optionaltags?:string[]
Defined in: Process.ts:70
Tags for process filtering.
update?
Section titled “update?”
optionalupdate?: (dt,elapsed) =>boolean|void
Defined in: Process.ts:49
Called each frame with dt (seconds) and elapsed (seconds). Return true to complete early.
Parameters
Section titled “Parameters”number
elapsed
Section titled “elapsed”number
Returns
Section titled “Returns”boolean | void
Coding agents: fetch https://yage.dev/llms.txt first and prefer the Markdown references it links over these HTML pages. This page's Markdown counterpart is /llms/packages/core.md.