API reference
See the generated Corral API reference. The default export
is the Shiitake client extension. attachCorral is the lower-level integration
for hosts that supply an activity stream directly.
Type Aliases
Section titled “Type Aliases”CorralEnvironment
Section titled “CorralEnvironment”CorralEnvironment =
Readonly<{HERDR_ENV?:string;HERDR_PANE_ID?:string;HERDR_SOCKET_PATH?:string; }>
Pane environment supplied by the local Herdr host.
CorralActivity
Section titled “CorralActivity”CorralActivity =
ClientActivityV0
Activity supplied by the client; blocked means a human response is pending.
Variables
Section titled “Variables”default
Section titled “default”
constdefault:ClientEntryV0
Ordinary Fungi client extension; disabled outside a Herdr pane.
Functions
Section titled “Functions”attachCorral()
Section titled “attachCorral()”attachCorral(
activity,options):Effect<void,Error,Scope>>
Attach to borrowed activity; never opens a Session watch or starts Herdr.
Parameters
Section titled “Parameters”activity
Section titled “activity”Stream<ClientActivityV0>
options
Section titled “options”Readonly<{ environment: CorralEnvironment;
onError: (cause) => void; }>
Returns
Section titled “Returns”Effect<void, Error, Scope>