Skip to content

Realm metadata

import { defineRealm } from "@embabel/realm-types";
export default defineRealm({
name: "oncall-radar",
version: "0.1.0",
host: "wasm",
execution: "captured",
description: "Open incidents on the status pages you depend on.",
tags: ["status", "incidents"],
handlers: {
/* ... */
},
});
Field Rule
name, version Required, non-empty.
host "wasm" or "docker", written to realm.yml only when present. Declare "wasm" for a TypeScript realm. Left out, the host infers placement from the files on disk (see placement), and a guess is the last thing a captured realm wants.
execution "captured" switches synth to the captured profiles. It is not written to realm.yml; the host runs the realm captured once the owner admits it.
runtime The guest language: "typescript" (the default), "python", "ruby", "lua" or "compiled". TypeScript is the only one a host builds from source. Any other value is written to dependencies/manifest.json. A realm in any other language cannot declare channels, sources or consumers.
entry The handler source file, relative to the realm, with no leading /, no \ and no .. segment. Defaults to wasm/handlers.ts, or wasm/handlers.py for Python and wasm/src/lib.rs for compiled. A declared entry must exist and is also written to dist/manifest.json.
icon A URL starting http:// or https://, written as is, or a realm-relative file, which must exist and which synth copies.
description, author, url, tags, exports, retry Written to realm.yml. tags and exports are written only when non-empty.
generatedAt The timestamp in dist/manifest.json. Defaults to 1970-01-01T00:00:00Z, so the output does not change from run to run.