Reference · Rockets, variants, parts and the fit check
checkfunction
Asks whether a rocket goes together, from the parts' records alone, with no three.js and no DOM. A rocket labelled as a real version uses only parts true for it; any mix is a custom build and says so.
Import it
import { check } from "@johnmorrisdotca/uchusen-rockets";
Definition
function check(description: Description): FitReport
Parameters
| Name | Type | Description |
|---|---|---|
description | Description | The rocket, its variant and any other part in a slot. |
Returns
FitReport
A report that says whether it fits and why, with the size and the credits.
Examples
import { check } from "@johnmorrisdotca/uchusen-rockets";
const report = check({ rocket: "starship", variant: "v3", parts: { booster: "starship-v3-ship" } });
console.log(report.ok, report.issues[0]?.message);false Ship, Block 3 (V3) is a ship; this slot takes a booster.What it prints (run when this page was built)