microfoom
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

PropertyModifierTypeDescriptionDefined in
className?readonlystringClass name in the source file, for derivation. Defaults to the constructor name.packages/microfoom-core/src/program.ts:206
defaultHarness?readonlystringWidest-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?readonlyAgentOptionsHarness-default config, the widest cascade scope.packages/microfoom-core/src/program.ts:208
harnessesreadonlyRecord<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
modelreadonlystring-packages/microfoom-core/src/program.ts:202
onEvent?readonly(event) => voidSubscribe 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?readonlyany-packages/microfoom-core/src/program.ts:209
sourceFile?readonlystringProgram source path — required for foom_call parameter derivation (ADR-0003).packages/microfoom-core/src/program.ts:204

On this page