@fungi.computer/corral
Type Aliases
Section titled “Type Aliases”CorralCommandRunner
Section titled “CorralCommandRunner”CorralCommandRunner = (
args) =>Promise<void>>
Optional injected helper runner; arguments include the executable path.
Parameters
Section titled “Parameters”readonly string[]
Returns
Section titled “Returns”Promise<void>
CorralEnvironment
Section titled “CorralEnvironment”CorralEnvironment =
Readonly<{HERDR_BIN_PATH?:string;HERDR_ENV?:string;HERDR_PANE_ID?:string; }>
Pane environment supplied by the local Herdr host.
CorralActivity
Section titled “CorralActivity”CorralActivity =
"idle"|"working"|"unknown"
Observed Session activity; unknown means observation is unavailable.
Variables
Section titled “Variables”default
Section titled “default”
constdefault:ShiitakeClientExtensionV0
Default fungi client entry; activates only in an existing Herdr environment.
Functions
Section titled “Functions”attachCorral()
Section titled “attachCorral()”attachCorral(
activity,options):Effect<void,Error,Scope>>
Attach reporting to activity supplied by the client; never opens a Session watch.
Parameters
Section titled “Parameters”activity
Section titled “activity”Stream<CorralActivity>
options
Section titled “options”Readonly<{ environment: CorralEnvironment;
onError: (cause) => void; run?:
CorralCommandRunner; }>
Returns
Section titled “Returns”Effect<void, Error, Scope>