Everything ensureImage needs besides the size class.
baseImage defaults to baseImageFromDockerfile(dockerfile); waitTimeoutSeconds is
the build wait, 45 minutes by default. contextDir is read as docker build reads a
context: Dockerfile.dockerignore, else .dockerignore, is honoured, and symlinks are
skipped with a line in the result’s warnings.
Properties
Section titled “Properties”baseImage?
Section titled “baseImage?”optional baseImage?: BaseImageInput;baseImageVersion?
Section titled “baseImageVersion?”optional baseImageVersion?: string;buildImage’s baseImageVersion; it joins the name’s hash.
binary
Section titled “binary”binary: Uint8Array;The daemon binary’s bytes.
buildRoleArn
Section titled “buildRoleArn”buildRoleArn: string;The build role.
contextDir?
Section titled “contextDir?”optional contextDir?: string;The directory the Dockerfile’s COPY lines read, or omitted for none.
dockerfile
Section titled “dockerfile”dockerfile: string;The Dockerfile, usually wrapDockerfile(task).
force?
Section titled “force?”optional force?: boolean;Delete what exists under the name and build afresh.
namePrefix
Section titled “namePrefix”namePrefix: string;The image name’s stem; the name is <namePrefix>-<hash12>.
projectDir?
Section titled “projectDir?”optional projectDir?: string;buildImage’s projectDir; the pair joins the name’s hash.
repairGuestIdentity?
Section titled “repairGuestIdentity?”optional repairGuestIdentity?: boolean;Repair guest identity during image creation. Part of the content-addressed name.
s3Bucket
Section titled “s3Bucket”s3Bucket: string;The artifact bucket, in the sandbox’s region.
s3KeyPrefix?
Section titled “s3KeyPrefix?”optional s3KeyPrefix?: string;A key prefix inside the bucket, or omitted for the bucket root.
optional tags?: Record<string, string>;waitTimeoutSeconds?
Section titled “waitTimeoutSeconds?”optional waitTimeoutSeconds?: number;Provenance
Section titled “Provenance”This page is generated from bindings/microvms-js/index.d.ts by TypeDoc 0.28.20 and typedoc-plugin-markdown 4.13.1, run from site/scripts/gen-reference.mjs on every pnpm run sync, so an edit made here is overwritten by the next run.
To change the page, change the doc comment in the binding’s Rust source, then regenerate the declarations with mise run dts. mise run dts:check fails when the committed file no longer matches the source.