A report’s total judged against a budget: core’s Budget::check, the verdict
microvm cost --max-cost renders.
Accessors
Section titled “Accessors”aborts
Section titled “aborts”Get Signature
Section titled “Get Signature”get aborts(): boolean;Whether the caller’s judgement refuses the report: breached, under "abort".
Returns
Section titled “Returns”boolean
Get Signature
Section titled “Get Signature”get basis(): string;"exact" or "lower-bound".
Returns
Section titled “Returns”string
breached
Section titled “breached”Get Signature
Section titled “Get Signature”get breached(): boolean;Whether the floor is over the ceiling. At the ceiling is within it.
Returns
Section titled “Returns”boolean
Get Signature
Section titled “Get Signature”get floor(): EstimatedUsd;The total’s floor: the whole estimate unless isLowerBound.
Returns
Section titled “Returns”isLowerBound
Section titled “isLowerBound”Get Signature
Section titled “Get Signature”get isLowerBound(): boolean;Whether the floor is a lower bound, because a line is unpriced.
Returns
Section titled “Returns”boolean
maxUsd
Section titled “maxUsd”Get Signature
Section titled “Get Signature”get maxUsd(): EstimatedUsd;The ceiling, as the caller wrote it.
Returns
Section titled “Returns”onBreach
Section titled “onBreach”Get Signature
Section titled “Get Signature”get onBreach(): string;"warn" or "abort": what the caller said a breach does.
Returns
Section titled “Returns”string
overage
Section titled “overage”Get Signature
Section titled “Get Signature”get overage(): EstimatedUsd | null;How far over the ceiling the floor is, when breached; at least that much for a lower bound.
Returns
Section titled “Returns”EstimatedUsd | null
unpricedPhases
Section titled “unpricedPhases”Get Signature
Section titled “Get Signature”get unpricedPhases(): string[];The phases whose lines are unpriced, sorted.
Returns
Section titled “Returns”string[]
Methods
Section titled “Methods”render()
Section titled “render()”render(): string;One line for a human, the one microvm cost --max-cost prints.
Returns
Section titled “Returns”string
toJson()
Section titled “toJson()”toJson(): string;Core’s JSON shape for the verdict, as a JSON string: maxUsd, onBreach, basis,
breached, overageAtLeastUsd.
Returns
Section titled “Returns”string
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.