Per-phase attribution for one sandbox, measured or projected.
Accessors
Section titled “Accessors”complete
Section titled “complete”Get Signature
Section titled “Get Signature”get complete(): boolean;False whenever any phase has no published rate.
Returns
Section titled “Returns”boolean
fullyMeasured
Section titled “fullyMeasured”Get Signature
Section titled “Get Signature”get fullyMeasured(): boolean;True only if every duration was timed. An estimate is never this.
Returns
Section titled “Returns”boolean
Get Signature
Section titled “Get Signature”get items(): LineItem[];Returns
Section titled “Returns”LineItem[]
Get Signature
Section titled “Get Signature”get label(): string;Returns
Section titled “Returns”string
priced
Section titled “priced”Get Signature
Section titled “Get Signature”get priced(): LineItem[];The line items with a published rate.
Returns
Section titled “Returns”LineItem[]
Get Signature
Section titled “Get Signature”get rates(): RateTable;Returns
Section titled “Returns”Get Signature
Section titled “Get Signature”get size(): SizeClass;Returns
Section titled “Returns”staleness
Section titled “staleness”Get Signature
Section titled “Get Signature”get staleness(): string | null;The staleness warning the table carried when this was computed.
Returns
Section titled “Returns”string | null
Get Signature
Section titled “Get Signature”get total(): Total;The total, which is a lower bound whenever anything is unpriced.
Returns
Section titled “Returns”unpriced
Section titled “unpriced”Get Signature
Section titled “Get Signature”get unpriced(): LineItem[];The line items with no published rate.
Returns
Section titled “Returns”LineItem[]
Methods
Section titled “Methods”byPhase()
Section titled “byPhase()”byPhase(phase: string): LineItem[];The line items belonging to one phase.
The string is judged by the core’s own [CostPhase::from_str], which is where the
closed set lives. This file used to carry its own seven-element table for it, as did
bindings/microvms-py/src/cost.rs — two parallel lists over one enum, which would have gone
stale the first time a phase was added and would have disagreed with each other in
whichever direction was edited first.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
phase |
string |
Returns
Section titled “Returns”LineItem[]
render()
Section titled “render()”render(): string;Plain text, leading with what the dollars are rather than with the dollars.
Returns
Section titled “Returns”string
toJson()
Section titled “toJson()”toJson(): string;Core’s JSON shape for a report, as a JSON string: the one microvm cost --json
and Python’s to_dict emit (#255).
A string for the same reason [LineItem::to_json] is: the unpriced line item omits
its usd key, which no typed return shape can express.
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.