API referenceInterfaces
RunProgramOptions
Interface: RunProgramOptions
Defined in: packages/microfoom-core/src/program.ts:194
Options for running a program: the harness registry, model, source.
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
className? | readonly | string | Class name in the source file, for derivation. Defaults to the constructor name. | packages/microfoom-core/src/program.ts:206 |
defaultHarness? | readonly | string | Widest-scope harness name. Needed only when harnesses has 2+ entries and no narrower scope selects one. Must be a key of harnesses. | packages/microfoom-core/src/program.ts:201 |
defaults? | readonly | AgentOptions | Harness-default config, the widest cascade scope. | packages/microfoom-core/src/program.ts:208 |
harnesses | readonly | Record<string, OpenSession> | Named harness ports — each name opens sessions on one harness. A sole entry is the default; with several, set defaultHarness or select per scope via @foom.config({ harness }) / .with({ harness }). | packages/microfoom-core/src/program.ts:198 |
model | readonly | string | - | packages/microfoom-core/src/program.ts:202 |
onEvent? | readonly | (event) => void | Subscribe to the run's intrinsic event stream from outside the program (a CLI or harness renderer). Attached before main() runs, so the auto span tree (F8) is emitted from the first turn; when absent, nothing is emitted (zero cost on the common path). | packages/microfoom-core/src/program.ts:216 |
signal? | readonly | any | - | packages/microfoom-core/src/program.ts:209 |
sourceFile? | readonly | string | Program source path — required for foom_call parameter derivation (ADR-0003). | packages/microfoom-core/src/program.ts:204 |
