API reference
home/host
Import
Section titled “Import”import * as api from "@fungi.computer/shiitake-extensions/home/host";Exports
Section titled “Exports”| Kind | Export | Description |
|---|---|---|
| type alias | HomeComputer | Already-scoped authority supplied by the host, never constructed by Home. |
| constant | homeGrant | Hosts admit Home explicitly; no other extension receives the Files slot. |
| function | homeExtension() | Agent-scope choice with per-run tools and prompt over one captured table. |
HomeComputertype alias
Section titled “HomeComputer”type HomeComputer = Readonly<{ name: string; attachmentId: string; port: FilesPort;}>;Already-scoped authority supplied by the host, never constructed by Home.
homeGrantconstant
Section titled “homeGrant”const homeGrant: ExtensionGrantV0;Hosts admit Home explicitly; no other extension receives the Files slot.
homeExtension()function
Section titled “homeExtension()”function homeExtension(options): RosteredExtensionV0;Agent-scope choice with per-run tools and prompt over one captured table.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
options |
{ computers: { read: (context) => readonly Readonly<{ name: string; attachmentId: string; port: FilesPort; }>[]; prepare?: (context) => Promise<void>; }; } |
- |
options.computers |
{ read: (context) => readonly Readonly<{ name: string; attachmentId: string; port: FilesPort; }>[]; prepare?: (context) => Promise<void>; } |
- |
options.computers.read |
(context) => readonly Readonly<{ name: string; attachmentId: string; port: FilesPort; }>[] |
Read the table inside the synchronous Home choice transaction. |
options.computers.prepare? |
(context) => Promise<void> |
Optional host preparation before run-scoped Files capture. |
Returns
Section titled “Returns”RosteredExtensionV0