cloudflare
Classes
Section titled “Classes”abstract ShiitakeOwner
Section titled “abstract ShiitakeOwner”Owns runtime opening, HTTP/ACP transport, inbox observation and alarm recovery.
Type Parameters
Section titled “Type Parameters”Env
State extends CloudflareShiitakeState =
CloudflareShiitakeState
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ShiitakeOwner<
Env,State>>(ctx,env):ShiitakeOwner<Env,State>>
Parameters
Section titled “Parameters”State
Env
Returns
Section titled “Returns”ShiitakeOwner<Env, State>
Methods
Section titled “Methods”shiitake()
Section titled “shiitake()”shiitake():
Promise<CloudflareShiitake>>
Borrow this owner’s runtime directly; only the host owns its lifetime.
Returns
Section titled “Returns”Promise<CloudflareShiitake>
abortActiveSessions()
Section titled “abortActiveSessions()”abortActiveSessions():
Promise<void>>
Stop live execution without constructing a cold owner’s runtime.
Returns
Section titled “Returns”Promise<void>
closeShiitake()
Section titled “closeShiitake()”closeShiitake():
Promise<void>>
Close owned resources before storage erasure; a cold owner has none.
Returns
Section titled “Returns”Promise<void>
readInboxChanges()
Section titled “readInboxChanges()”readInboxChanges(
after,limit):Promise<Readonly<{rows: readonly (SessionSummaryRow|Readonly<{sessionId:string;deleted:true; }>)[];through:number;latest:number; }>>
Bounded strict-after read of this Agent’s changed inbox rows.
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”Promise<Readonly<{ rows: readonly
(SessionSummaryRow | Readonly<{
sessionId: string; deleted: true; }>)[]; through: number;
latest: number; }>>
readInboxRevision()
Section titled “readInboxRevision()”readInboxRevision():
number
Latest inbox revision; read only after the owner has opened.
Returns
Section titled “Returns”number
pruneInboxTombstones()
Section titled “pruneInboxTombstones()”pruneInboxTombstones(
through):void
Prune deletion deltas after every current member inbox has acknowledged them.
Parameters
Section titled “Parameters”through
Section titled “through”number
Returns
Section titled “Returns”void
wakeRuntime()
Section titled “wakeRuntime()”wakeRuntime():
Promise<void>>
Persist a wake and run one reconciliation pass, including host work.
Returns
Section titled “Returns”Promise<void>
alarm()
Section titled “alarm()”alarm():
Promise<void>>
Native alarms reconstruct the owner without an incoming user request. A construction or wake failure must not strand the claimed work on platform alarm retries: it is caught, logged, and explicitly re-armed with bounded backoff instead.
Returns
Section titled “Returns”Promise<void>
fetch()
Section titled “fetch()”fetch(
request):Promise<Response>>
Serve Shiitake’s complete transport without subclass routing.
Parameters
Section titled “Parameters”request
Section titled “request”Request
Returns
Section titled “Returns”Promise<Response>
abstract ShiitakeDO
Section titled “abstract ShiitakeDO”Native Cloudflare entry points; all runtime lifetime belongs to the owner.
Extends
Section titled “Extends”DurableObject<Env>
Type Parameters
Section titled “Type Parameters”Env
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ShiitakeDO<
Env>>(ctx,env):ShiitakeDO<Env>>
Parameters
Section titled “Parameters”DurableObjectState
Env
Returns
Section titled “Returns”ShiitakeDO<Env>
Inherited from
Section titled “Inherited from”DurableObject<Env>.constructor
Methods
Section titled “Methods”alarm()
Section titled “alarm()”alarm():
Promise<void>>
Reconcile due runtime and host work through the owner.
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”DurableObject.alarm
fetch()
Section titled “fetch()”fetch(
request):Promise<Response>>
Route an authenticated client request through the owner.
Parameters
Section titled “Parameters”request
Section titled “request”Request
Returns
Section titled “Returns”Promise<Response>
Overrides
Section titled “Overrides”DurableObject.fetch
Type Aliases
Section titled “Type Aliases”CloudflareShiitakeState
Section titled “CloudflareShiitakeState”CloudflareShiitakeState =
Readonly<{storage:SqliteOwner&Pick<DurableObjectStorage,"getAlarm"|"setAlarm"|"deleteAlarm"> > &object;waitUntil: (task) =>void; }>
Native Durable Object capabilities used by the Cloudflare adapter.
CloudflareShiitakeTools
Section titled “CloudflareShiitakeTools”CloudflareShiitakeTools =
Readonly<{modules?: readonlyModuleRegistration[];sources?: readonlyCapabilitySource[];sandbox:Sandbox; }>
Non-empty Mycelium capabilities supplied by a Cloudflare host.
CloudflareHostWork
Section titled “CloudflareHostWork”CloudflareHostWork =
Readonly<{pending: () =>Readonly<{due:boolean;nextWakeAt:number|null; }>;run: () =>Promise<void>>; }>
Durable host work that shares Shiitake’s one native alarm, such as a host-owned delivery outbox. Shiitake never interprets it.
CloudflareHostJobs
Section titled “CloudflareHostJobs”CloudflareHostJobs =
Readonly<{lane:string;open: (runtime) =>Readonly<{execute: (job) =>Promise<WatchdogExecutionDecision>>; }>; }>
Host jobs share Shiitake’s one Watchdog claim and native alarm.
CloudflareShiitakeAcpServer
Section titled “CloudflareShiitakeAcpServer”CloudflareShiitakeAcpServer =
Readonly<{handleRequest: (request) =>Promise<Response>>; }>
ACP’s maintained transport, supplied by the host without a package cycle.
CloudflareShiitakeOptions
Section titled “CloudflareShiitakeOptions”CloudflareShiitakeOptions =
Readonly<{model:ModelSource;instructions:InstructionSource;tools?: readonly [] |CloudflareShiitakeTools;files?:FilesSurface;gateTool?: (input) =>OperationGate;extensions:ExtensionRosterV0;hostWork?: readonlyCloudflareHostWork[];hostJobs?:CloudflareHostJobs;browser?: (sessionId) =>BrowserHost;acp?: (agent) =>Promise<CloudflareShiitakeAcpServer>>; }>
Cloudflare host inputs; the model owner resolves one frozen run selection.
CloudflareShiitake
Section titled “CloudflareShiitake”CloudflareShiitake =
ShiitakeAgent&Readonly<{alarm: () =>Promise<void>>;activeSessions: () =>Promise<readonlystring[]>;abortActive: () =>Promise<void>>;browser:Readonly<{fetch: (request) =>Promise<Response>>;clear: () =>Promise<void>>; }>; }>
Cloudflare host lifecycle; alarm forwarding stays outside the neutral client.
BrowserHost
Section titled “BrowserHost”BrowserHost =
Readonly<{modules: readonlyModuleRegistration[];fetch: (request) =>Promise<Response>>; }>
The maintained browser transport and its Session-bound tool descriptors.
SessionInboxChanges
Section titled “SessionInboxChanges”SessionInboxChanges =
Readonly<{rows: readonly (SessionSummaryRow|Readonly<{sessionId:string;deleted:true; }>)[];through:number;latest:number; }>
Revisioned Session inbox changes after one owner revision, oldest first.
Functions
Section titled “Functions”makeCloudflareShiitake()
Section titled “makeCloudflareShiitake()”makeCloudflareShiitake(
state,options):Promise<CloudflareShiitake>>
Construct Shiitake over one Durable Object’s SQLite and lifetime.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<CloudflareShiitake>