@johnmorrisdotca/uchusen-rockets 0.3.0 → 0.4.0

package/dist/framing.js

@@ -1,11 +1,69 @@
 // Where the camera stands. One rule for the drawing and the 3D view, so the drawing turns into the 3D view without a jump. Pure, in metres.
-/** The camera's field of view, in degrees, top to bottom. Narrow, because a rocket is long. */
+/**
+ * The camera's field of view, in degrees, top to bottom. Narrow, because a rocket is long.
+ *
+ * @example
+ * ```ts
+ * import { FOV_DEG } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(FOV_DEG);
+ * ```
+ */
 export const FOV_DEG = 24;
-/** The picture's shape. */
+/**
+ * The width of the picture a drawing is made in, in drawing units.
+ *
+ * @example
+ * ```ts
+ * import { PICTURE_W, PICTURE_H } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(PICTURE_W, PICTURE_H);
+ * ```
+ */
 export const PICTURE_W = 480;
+/**
+ * The height of the picture a drawing is made in, in drawing units.
+ *
+ * @example
+ * ```ts
+ * import { PICTURE_H } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(PICTURE_H);
+ * ```
+ */
 export const PICTURE_H = 640;
+/**
+ * The names of the views, in the order the demo lists them: `three-quarter`, `front`, `back`, `side` and `below`.
+ *
+ * @example
+ * ```ts
+ * import { VIEW_NAMES } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(VIEW_NAMES.join(", "));
+ * ```
+ */
 export const VIEW_NAMES = ["three-quarter", "front", "back", "side", "below"];
+/**
+ * The view used when none is named or the name is not a view: `three-quarter`.
+ *
+ * @example
+ * ```ts
+ * import { DEFAULT_VIEW } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(DEFAULT_VIEW);
+ * ```
+ */
 export const DEFAULT_VIEW = "three-quarter";
+/**
+ * The angle of each named view.
+ *
+ * @example
+ * ```ts
+ * import { VIEWS } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(VIEWS.front, VIEWS.below);
+ * ```
+ */
 export const VIEWS = {
     "three-quarter": { az: 32, el: 9 },
     front: { az: 0, el: 3 },
@@ -13,13 +71,49 @@ export const VIEWS = {
     side: { az: 90, el: 3 },
     below: { az: 24, el: -70 },
 };
+/**
+ * A value from outside as a view's name.
+ *
+ * @param value Anything.
+ * @returns The name if it is one of the views, and `three-quarter` for anything else.
+ * @example
+ * ```ts
+ * import { cleanView } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(cleanView("side"), cleanView("sideways"), cleanView(42));
+ * ```
+ */
 export const cleanView = (value) => (VIEW_NAMES.includes(value) ? value : DEFAULT_VIEW);
 export const deg = (d) => (d * Math.PI) / 180;
-/** What the family's view controls choose: the turn and tip, in degrees, from a base angle. Dragging right makes `yaw` larger, which carries the camera the other way round; `tilt` larger tips the top away, which lowers the camera. */
+/**
+ * What the family's view controls choose: the turn and tip, in degrees, from a base angle. Dragging right makes `yaw` larger, which carries the camera the other way round; `tilt` larger tips the top away, which lowers the camera.
+ *
+ * @param base The angle to turn from.
+ * @param yaw Degrees turned round.
+ * @param tilt Degrees tipped up or down.
+ * @returns The new angle.
+ * @example
+ * ```ts
+ * import { turnedBy, VIEWS } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(turnedBy(VIEWS.front, 30, 10));
+ * ```
+ */
 export function turnedBy(base, yaw, tilt) {
     return { az: base.az - yaw, el: Math.min(87, Math.max(-87, base.el - tilt)) };
 }
-/** The unit vector from what is looked at towards the camera. */
+/**
+ * The unit vector from what is looked at towards the camera.
+ *
+ * @param angle The angle to look from.
+ * @returns A unit vector.
+ * @example
+ * ```ts
+ * import { directionOf } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(directionOf({ az: 0, el: 0 }));
+ * ```
+ */
 export function directionOf({ az, el }) {
     const c = Math.cos(deg(el));
     return [c * Math.sin(deg(az)), Math.sin(deg(el)), c * Math.cos(deg(az))];
@@ -30,14 +124,41 @@ const unit = (a) => {
     const l = Math.hypot(...a) || 1;
     return [a[0] / l, a[1] / l, a[2] / l];
 };
-/** The camera's own axes for looking along `direction`, with up as near to +Y as it can be. */
+/**
+ * The camera's own axes for looking along `direction`, with up as near to +Y as it can be.
+ *
+ * @param direction The direction from the target to the camera.
+ * @returns The camera's right, up and forward axes.
+ * @example
+ * ```ts
+ * import { axesOf } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(axesOf([0, 0, 1]));
+ * ```
+ */
 export function axesOf(direction) {
     const forward = [-direction[0], -direction[1], -direction[2]];
     const near = Math.abs(forward[1]) > 0.999;
     const right = unit(cross(forward, near ? [0, 0, -1] : [0, 1, 0]));
     return { right, up: cross(right, forward), forward };
 }
-/** The nearest camera that holds the whole of `min` to `max` in a picture `aspect` wide for 1 tall, from `angle`. */
+/**
+ * The nearest camera that holds the whole of `min` to `max` in a picture `aspect` wide for 1 tall, from `angle`.
+ *
+ * @param min The lowest corner of the box to hold.
+ * @param max The highest corner.
+ * @param angle The angle to look from.
+ * @param aspect The picture's width over its height.
+ * @param margin Room left round the box, as a multiple. Defaults to 1.08.
+ * @returns The camera that holds the whole box.
+ * @example
+ * ```ts
+ * import { frameFor, VIEWS } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * const framing = frameFor([-4.5, 0, -4.5], [4.5, 124, 4.5], VIEWS.front, 480 / 640);
+ * console.log(framing.target, framing.distance.toFixed(0));
+ * ```
+ */
 export function frameFor(min, max, angle, aspect, margin = 1.08) {
     const target = [(min[0] + max[0]) / 2, (min[1] + max[1]) / 2, (min[2] + max[2]) / 2];
     const direction = directionOf(angle);

package/dist/layout.d.ts

@@ -1,16 +1,80 @@
 import type { Vec3 } from "./framing.ts";
 import type { PartRecord } from "./parts.ts";
+/**
+ * What to show of a rocket: `together`, `apart`, or the slot of one part, such as `booster`.
+ *
+ * @example
+ * ```ts
+ * import type { ShowName } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * const shows: ShowName[] = ["together", "apart", "booster"];
+ * console.log(shows);
+ * ```
+ */
 export type ShowName = "together" | "apart" | (string & {});
 /** A part's own width from the axis, for keeping apart parts clear of each other. */
 export type WidthOf = (part: PartRecord) => number;
+/**
+ * Where one part stands for a choice of what to show: its slot, its position in metres and whether it is shown at all.
+ *
+ * @example
+ * ```ts
+ * import { placesFor, type Place } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * const places: Place[] = placesFor([], "together", () => 1);
+ * console.log(places.length);
+ * ```
+ */
 export interface Place {
     slot: string;
     at: Vec3;
     shown: boolean;
 }
-/** The first choices of `show`, then one per slot. */
+/**
+ * The first choices of `show`, then one per slot.
+ *
+ * @param slots A variant's slots, from the bottom.
+ * @returns What can be shown: together and apart first when there is more than one slot, then one for each slot.
+ * @example
+ * ```ts
+ * import { showsOf, variantOf } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(showsOf(variantOf("falcon-9", "block-5")?.slots ?? []));
+ * ```
+ */
 export declare const showsOf: (slots: readonly string[]) => string[];
+/**
+ * A value from outside as something that can be shown.
+ *
+ * @param value Anything.
+ * @param slots The variant's slots.
+ * @returns The value if it can be shown, and the first choice (together) for anything else.
+ * @example
+ * ```ts
+ * import { cleanShow, variantOf } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * const slots = variantOf("falcon-9", "block-5")?.slots ?? [];
+ * console.log(cleanShow("first-stage", slots), cleanShow("nonsense", slots));
+ * ```
+ */
 export declare function cleanShow(value: unknown, slots: readonly string[]): string;
+/**
+ * Where each part stands: up the stack joint to joint, or spread apart on a diagonal of the ground, or one part alone.
+ *
+ * @param parts The parts with their slots, from the bottom.
+ * @param show What to show.
+ * @param widthOf The width of a part, for spacing when they are apart.
+ * @returns A place for each part.
+ * @example
+ * ```ts
+ * import { build } from "@johnmorrisdotca/uchusen-rockets/build";
+ * import { placesFor } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * const rocket = build({ rocket: "falcon-9", variant: "block-5" });
+ * const parts = rocket.parts.map((part) => ({ slot: part.slot, part: part.record }));
+ * console.log(placesFor(parts, "apart", (part) => part.diameter / 2).map((place) => place.slot));
+ * ```
+ */
 export declare function placesFor(parts: readonly {
     slot: string;
     part: PartRecord;

package/dist/layout.js

@@ -1,11 +1,53 @@
 /** Seen square-on to the diagonal the parts take the whole distance; from the front or the side, seven tenths of it. */
 const APART_SPREAD = 1.45;
-/** The first choices of `show`, then one per slot. */
+/**
+ * The first choices of `show`, then one per slot.
+ *
+ * @param slots A variant's slots, from the bottom.
+ * @returns What can be shown: together and apart first when there is more than one slot, then one for each slot.
+ * @example
+ * ```ts
+ * import { showsOf, variantOf } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(showsOf(variantOf("falcon-9", "block-5")?.slots ?? []));
+ * ```
+ */
 export const showsOf = (slots) => (slots.length > 1 ? ["together", "apart", ...slots] : [...slots]);
+/**
+ * A value from outside as something that can be shown.
+ *
+ * @param value Anything.
+ * @param slots The variant's slots.
+ * @returns The value if it can be shown, and the first choice (together) for anything else.
+ * @example
+ * ```ts
+ * import { cleanShow, variantOf } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * const slots = variantOf("falcon-9", "block-5")?.slots ?? [];
+ * console.log(cleanShow("first-stage", slots), cleanShow("nonsense", slots));
+ * ```
+ */
 export function cleanShow(value, slots) {
     const shows = showsOf(slots);
     return typeof value === "string" && shows.includes(value) ? value : shows[0];
 }
+/**
+ * Where each part stands: up the stack joint to joint, or spread apart on a diagonal of the ground, or one part alone.
+ *
+ * @param parts The parts with their slots, from the bottom.
+ * @param show What to show.
+ * @param widthOf The width of a part, for spacing when they are apart.
+ * @returns A place for each part.
+ * @example
+ * ```ts
+ * import { build } from "@johnmorrisdotca/uchusen-rockets/build";
+ * import { placesFor } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * const rocket = build({ rocket: "falcon-9", variant: "block-5" });
+ * const parts = rocket.parts.map((part) => ({ slot: part.slot, part: part.record }));
+ * console.log(placesFor(parts, "apart", (part) => part.diameter / 2).map((place) => place.slot));
+ * ```
+ */
 export function placesFor(parts, show, widthOf) {
     if (show === "apart") {
         const widths = parts.map(({ part }) => widthOf(part));

package/dist/looks.d.ts

@@ -1,6 +1,48 @@
+/**
+ * The names of the looks: `line`, `thick` and `painted`.
+ *
+ * @example
+ * ```ts
+ * import { LOOK_NAMES } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(LOOK_NAMES.join(", "));
+ * ```
+ */
 export declare const LOOK_NAMES: readonly ["line", "thick", "painted"];
+/**
+ * The name of one look in `LOOK_NAMES`.
+ *
+ * @example
+ * ```ts
+ * import type { LookName } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * const look: LookName = "thick";
+ * console.log(look);
+ * ```
+ */
 export type LookName = (typeof LOOK_NAMES)[number];
+/**
+ * The look used when none is named or the name is not a look: `line`.
+ *
+ * @example
+ * ```ts
+ * import { DEFAULT_LOOK } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(DEFAULT_LOOK);
+ * ```
+ */
 export declare const DEFAULT_LOOK: LookName;
+/**
+ * What a look changes: the colour and width of its lines in a 3D view and in a drawing, how much of the weld lines shows, the fills by material group and whether there is a halo. A look never changes a shape.
+ *
+ * @example
+ * ```ts
+ * import { LOOKS, type Look } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * const thick: Look = LOOKS.thick;
+ * console.log(thick.line, thick.outline);
+ * ```
+ */
 export interface Look {
     /** The colour of its lines. */
     line: string;
@@ -20,6 +62,27 @@ export interface Look {
     halo: boolean;
 }
 export type FillName = "hull" | "white" | "tile" | "metal" | "dark" | "bell" | "foam";
+/**
+ * Every look, by name. A look is one entry of this table.
+ *
+ * @example
+ * ```ts
+ * import { LOOKS } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(Object.keys(LOOKS));
+ * ```
+ */
 export declare const LOOKS: Readonly<Record<LookName, Look>>;
-/** A value from outside as a look's name: the default for anything else. */
+/**
+ * A value from outside as a look's name: the default for anything else.
+ *
+ * @param value Anything.
+ * @returns The look's name if it is one, and the default (`line`) for anything else.
+ * @example
+ * ```ts
+ * import { cleanLook } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(cleanLook("painted"), cleanLook("shiny"));
+ * ```
+ */
 export declare const cleanLook: (value: unknown) => LookName;

package/dist/looks.js

@@ -1,5 +1,25 @@
 // The three looks, each one table entry: the line drawing, the thick lines, and the painted rocket. A look changes lines, colours and fills, never a shape. Pure.
+/**
+ * The names of the looks: `line`, `thick` and `painted`.
+ *
+ * @example
+ * ```ts
+ * import { LOOK_NAMES } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(LOOK_NAMES.join(", "));
+ * ```
+ */
 export const LOOK_NAMES = ["line", "thick", "painted"];
+/**
+ * The look used when none is named or the name is not a look: `line`.
+ *
+ * @example
+ * ```ts
+ * import { DEFAULT_LOOK } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(DEFAULT_LOOK);
+ * ```
+ */
 export const DEFAULT_LOOK = "line";
 const NIGHT = {
     hull: ["#0c1422", "#2a3850", "#0c1422"],
@@ -10,6 +30,16 @@ const NIGHT = {
     bell: ["#0a0f18", "#242f42", "#0a0f18"],
     foam: ["#16202f", "#3a475c", "#16202f"],
 };
+/**
+ * Every look, by name. A look is one entry of this table.
+ *
+ * @example
+ * ```ts
+ * import { LOOKS } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(Object.keys(LOOKS));
+ * ```
+ */
 export const LOOKS = {
     line: { line: "#8fa1b8", outlinePx: 1.4, featurePx: 1, weldPx: 0.6, weldOpacity: 0.45, outline: 1.2, feature: 0.8, weld: 0.45, fills: NIGHT, halo: true },
     thick: { line: "#b4c2d4", outlinePx: 3.4, featurePx: 2, weldPx: 0.9, weldOpacity: 0.5, outline: 3.4, feature: 1.7, weld: 0.6, fills: NIGHT, halo: true },
@@ -34,5 +64,16 @@ export const LOOKS = {
         halo: false,
     },
 };
-/** A value from outside as a look's name: the default for anything else. */
+/**
+ * A value from outside as a look's name: the default for anything else.
+ *
+ * @param value Anything.
+ * @returns The look's name if it is one, and the default (`line`) for anything else.
+ * @example
+ * ```ts
+ * import { cleanLook } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(cleanLook("painted"), cleanLook("shiny"));
+ * ```
+ */
 export const cleanLook = (value) => (LOOK_NAMES.includes(value) ? value : DEFAULT_LOOK);

package/dist/model/materials.d.ts

@@ -1,4 +1,15 @@
 import type { FillName } from "../looks.ts";
+/**
+ * One material: its colour, how metal and how rough it is in a 3D view, and the fill group it takes in a drawing.
+ *
+ * @example
+ * ```ts
+ * import { MATERIALS, type MaterialSpec } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * const steel: MaterialSpec = MATERIALS.steel;
+ * console.log(steel.color, steel.fill);
+ * ```
+ */
 export interface MaterialSpec {
     color: string;
     metal: number;
@@ -6,6 +17,16 @@ export interface MaterialSpec {
     /** The fill it takes in a drawing. */
     fill: FillName;
 }
+/**
+ * Every material the meshes use, by name. One naming scheme serves every source.
+ *
+ * @example
+ * ```ts
+ * import { MATERIALS } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(Object.keys(MATERIALS).length > 5);
+ * ```
+ */
 export declare const MATERIALS: {
     readonly steel: {
         readonly color: "#c3c7cb";
@@ -152,4 +173,15 @@ export declare const MATERIALS: {
         readonly fill: "metal";
     };
 };
+/**
+ * The name of one material in `MATERIALS`.
+ *
+ * @example
+ * ```ts
+ * import type { MaterialName } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * const name: MaterialName = "steel";
+ * console.log(name);
+ * ```
+ */
 export type MaterialName = keyof typeof MATERIALS;

package/dist/model/materials.js

@@ -1,3 +1,13 @@
+/**
+ * Every material the meshes use, by name. One naming scheme serves every source.
+ *
+ * @example
+ * ```ts
+ * import { MATERIALS } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(Object.keys(MATERIALS).length > 5);
+ * ```
+ */
 export const MATERIALS = {
     steel: { color: "#c3c7cb", metal: 1, rough: 0.3, fill: "hull" },
     tile: { color: "#101114", metal: 0, rough: 0.62, fill: "tile" },

package/dist/model/registry.d.ts

@@ -4,5 +4,27 @@ export interface PartEntry {
     record: PartRecord;
     pieces: () => Piece[];
 }
+/**
+ * Every part of every rocket, each with its record: its real size in metres, the joints it mates at, and where its shape came from.
+ *
+ * @example
+ * ```ts
+ * import { PART_ENTRIES } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(PART_ENTRIES.length, PART_ENTRIES[0]?.record.name);
+ * ```
+ */
 export declare const PART_ENTRIES: readonly PartEntry[];
+/**
+ * Finds a part by its id.
+ *
+ * @param id A part's id.
+ * @returns The part's entry, or undefined for an id that is not a part.
+ * @example
+ * ```ts
+ * import { partEntry } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(partEntry("raptor-vacuum")?.record.height, partEntry("nonsense"));
+ * ```
+ */
 export declare const partEntry: (id: string) => PartEntry | undefined;

package/dist/model/registry.js

@@ -162,6 +162,28 @@ const RAPTOR_LENGTH = { value: 3.1, source: "wikipedia-raptor", note: "The famil
 const b3 = STARSHIP_DRAWS.v3;
 const b2 = STARSHIP_DRAWS.v2;
 entries.push(detail("raptor-sea-level", "engine", "Raptor, sea-level", 3.1, 1.24, { height: RAPTOR_LENGTH, diameter: RAPTOR_DIAMETER }, () => raptor([0, 0], 0, "sea")), detail("raptor-vacuum", "engine", "Raptor, vacuum", 4.4, 2.3, { height: blankFigure, diameter: blankFigure }, () => raptor([0, 0], 0, "vacuum")), detail("grid-fin-four", "fin", "Grid fin, Blocks 1 and 2", 0.9, 2.9, { height: blankFigure, diameter: blankFigure }, () => gridFin(90, 0, b2.radius, b2.fins.reach, b2.fins.width, b2.fins.thick, false)), detail("grid-fin-three", "fin", "Grid fin, Block 3", 0.9, 3.4, { height: blankFigure, diameter: blankFigure }, () => gridFin(90, 0, b3.radius, b3.fins.reach, b3.fins.width, b3.fins.thick, true)), detail("flap-aft", "flap", "Aft flap", 11.6, 3.8, { height: blankFigure, diameter: blankFigure }, () => [flap(b3.aft, 1)]), detail("flap-forward", "flap", "Forward flap, Blocks 2 and 3", 8.1, 4.7, { height: blankFigure, diameter: blankFigure }, () => [flap(b3.forward, 1)]), detail("merlin-sea-level", "engine", "Merlin, sea-level", 2, 0.92, { height: blankFigure, diameter: blankFigure }, () => merlin([0, 0], 0, 0.46, 2)));
+/**
+ * Every part of every rocket, each with its record: its real size in metres, the joints it mates at, and where its shape came from.
+ *
+ * @example
+ * ```ts
+ * import { PART_ENTRIES } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(PART_ENTRIES.length, PART_ENTRIES[0]?.record.name);
+ * ```
+ */
 export const PART_ENTRIES = entries;
 const byId = new Map(entries.map((entry) => [entry.record.id, entry]));
+/**
+ * Finds a part by its id.
+ *
+ * @param id A part's id.
+ * @returns The part's entry, or undefined for an id that is not a part.
+ * @example
+ * ```ts
+ * import { partEntry } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(partEntry("raptor-vacuum")?.record.height, partEntry("nonsense"));
+ * ```
+ */
 export const partEntry = (id) => byId.get(id);

package/dist/parts.d.ts

@@ -1,7 +1,28 @@
 import type { CreditId } from "./data/credits.ts";
 import type { Figure } from "./data/types.ts";
+/**
+ * What kind of part a record is: a booster, a ship, a stage, a fairing, a capsule, an engine, a fin and so on. A joint only mates a part of a kind that fits it.
+ *
+ * @example
+ * ```ts
+ * import { partEntry, type PartKind } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * const kind: PartKind | undefined = partEntry("raptor-vacuum")?.record.kind;
+ * console.log(kind);
+ * ```
+ */
 export type PartKind = "booster" | "first-stage" | "ship" | "second-stage" | "fairing" | "capsule" | "trunk" | "engine" | "fin" | "flap" | "ring" | "test-vehicle" | "third-stage" | "adapter" | "service-module" | "tower" | "tank" | "solid-booster" | "liquid-booster" | "orbiter" | "deck" | "mount" | "arms" | "site" | "spacecraft";
-/** Where a part mates. Every part's origin is the middle of its base on its axis, at its lowest point; Y is up and the windward side faces +Z, in metres. */
+/**
+ * Where a part mates. Every part's origin is the middle of its base on its axis, at its lowest point; Y is up and the windward side faces +Z, in metres.
+ *
+ * @example
+ * ```ts
+ * import { partEntry, type Joint } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * const top: Joint | undefined = partEntry("starship-v3-booster")?.record.joints.top;
+ * console.log(top);
+ * ```
+ */
 export interface Joint {
     /** What this joint is, so only like meets like: "stage". */
     kind: "stage";
@@ -10,6 +31,17 @@ export interface Joint {
     /** Metres across at the joint. */
     diameter: number;
 }
+/**
+ * The one record every part has: its id, kind and name, the rocket and variants it is true for, its height and diameter in metres, the sourced figures, its joints, any painted model, and where its shape came from.
+ *
+ * @example
+ * ```ts
+ * import { partEntry, type PartRecord } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * const record: PartRecord | undefined = partEntry("starship-v3-ship")?.record;
+ * console.log(record?.name, record?.height, record?.trueTo);
+ * ```
+ */
 export interface PartRecord {
     id: string;
     kind: PartKind;

package/dist/pixels.d.ts

@@ -1,8 +1,48 @@
-/** The most the backing store may hold, in pixels (a 620 x 827 view at a ratio of 2 is 2 million). */
+/**
+ * The most the backing store may hold, in pixels (a 620 x 827 view at a ratio of 2 is 2 million).
+ *
+ * @example
+ * ```ts
+ * import { MAX_PIXELS } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(MAX_PIXELS);
+ * ```
+ */
 export declare const MAX_PIXELS = 6000000;
-/** The longest side the backing store may have. */
+/**
+ * The longest side the backing store may have.
+ *
+ * @example
+ * ```ts
+ * import { MAX_SIDE } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(MAX_SIDE);
+ * ```
+ */
 export declare const MAX_SIDE = 4096;
-/** The sharpest ratio ever used, however dense the screen. */
+/**
+ * The sharpest ratio ever used, however dense the screen.
+ *
+ * @example
+ * ```ts
+ * import { MAX_RATIO } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(MAX_RATIO);
+ * ```
+ */
 export declare const MAX_RATIO = 2;
-/** The device pixel ratio to draw a `width` x `height` view at: the screen's own, held to 2, to 4096 pixels a side and to 6 million in all. At least 0.25, and 1 for a nonsense value. */
+/**
+ * The device pixel ratio to draw a `width` x `height` view at: the screen's own, held to 2, to 4096 pixels a side and to 6 million in all. At least 0.25, and 1 for a nonsense value.
+ *
+ * @param width The view's width in CSS pixels.
+ * @param height Its height in CSS pixels.
+ * @param deviceRatio The screen's own pixel ratio.
+ * @returns The ratio to draw at.
+ * @example
+ * ```ts
+ * import { pixelRatioFor } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(pixelRatioFor(620, 827, 3), pixelRatioFor(3000, 3000, 2));
+ * ```
+ */
 export declare function pixelRatioFor(width: number, height: number, deviceRatio: number): number;