Interface WorkspaceBackend

packages/computer/src/backend.ts:39–71

}

export interface WorkspaceBackend {
  // User-supplied selector. Passed in `ExecOptions.backend` and
  // `Workspace.push(id)` / `Workspace.pull(id)` to address this
  // backend. The Workspace constructor rejects duplicate ids.
  //
  // Each concrete backend constructor accepts an `id` option
  // and defaults it to a sensible string when omitted: "test"
  // for TestBackend, "container-shell" for the container
  // backend, and "worker-shell" for the worker shell backend. Single-backend
  // setups can ride the default and never touch the field.
  readonly id: string;

  // Diagnostic kind of backend, fixed by the implementation
  // ("test", "cloudflare-container", "worker-shell"). Used for
  // tracing spans and stub-leak counters; not consumed by
  // Workspace selection logic.
  readonly type: string;

  // Whether the backend accepts a structured `input` value and
  // returns a structured `result` value. Independent of the
  // implementation kind: a shell backend that coerces JSON to
  // argv/stdin and parses stdout back to a value can be callable
  // too. Defaults to false when omitted.
  readonly callable?: boolean;

  // Materialise a connection. Called lazily on first use, once
  // per backend per workspace lifetime. The Workspace caches the
  // resulting handle by `id`; subsequent exec / push / pull
  // calls reuse it. The Workspace always passes its host bag;
  // backends that reach the host through their own transport
  // ignore it.
  connect(host: WorkspaceBackendHost): Promise<BackendHandle>;
}

export interface BackendHandle {
  // The composite WorkspaceRPC stub pointing at the computerd