@johnmorrisdotca/uchusen-rockets 0.3.0 → 0.4.0

package/dist/build/index.d.ts

@@ -5,11 +5,36 @@ import { type PartMesh, type Bounds, type Piece } from "../model/pieces.ts";
 import type { PartRecord } from "../parts.ts";
 import { type LitBell } from "../engines.ts";
 import { type Glb, toGlb } from "./glb.ts";
-/** Raised when a description does not fit: its report says why. */
+/**
+ * Raised by `build` when a description does not fit. Its `report` says why, in the same words `check` gives.
+ *
+ * @param report The report of the fit check that failed.
+ * @example
+ * ```ts
+ * import { build, FitError } from "@johnmorrisdotca/uchusen-rockets/build";
+ *
+ * try {
+ *   build({ rocket: "starship", variant: "v3", parts: { booster: "starship-v3-ship" } });
+ * } catch (error) {
+ *   if (error instanceof FitError) console.log(error.report.issues[0]?.message);
+ * }
+ * ```
+ */
 export declare class FitError extends Error {
     readonly report: FitReport;
     constructor(report: FitReport);
 }
+/**
+ * One part of a built rocket: its slot, its record, the pieces it is made of, its mesh and its bounds in metres.
+ *
+ * @example
+ * ```ts
+ * import { build, type BuiltPart } from "@johnmorrisdotca/uchusen-rockets/build";
+ *
+ * const first: BuiltPart | undefined = build({ rocket: "falcon-9", variant: "block-5" }).parts[0];
+ * console.log(first?.slot, first?.record.name);
+ * ```
+ */
 export interface BuiltPart {
     slot: string;
     record: PartRecord;
@@ -17,6 +42,17 @@ export interface BuiltPart {
     mesh: PartMesh;
     bounds: Bounds;
 }
+/**
+ * What a drawing is asked for: the look, the view, what to show and whether the engines are lit. Anything left out takes its default.
+ *
+ * @example
+ * ```ts
+ * import { build, type SvgOptions } from "@johnmorrisdotca/uchusen-rockets/build";
+ *
+ * const options: SvgOptions = { look: "thick", view: "below", show: "booster" };
+ * console.log(build({ rocket: "starship", variant: "v3" }).svg(options).startsWith("<svg"));
+ * ```
+ */
 export interface SvgOptions {
     look?: LookName;
     view?: ViewName | Angle;
@@ -24,6 +60,18 @@ export interface SvgOptions {
     /** A flame at each engine that is showing, or as many as a count names for each part. The length is a picture, not a measured flame. Left out, the drawing is unchanged. */
     engines?: boolean | Readonly<Record<string, number>>;
 }
+/**
+ * A rocket built from a description: the fit report, its parts, and the ways to ask for its size, where each part stands, its lit engines, a `.glb` file and a drawing.
+ *
+ * @example
+ * ```ts
+ * import { build, type Built } from "@johnmorrisdotca/uchusen-rockets/build";
+ *
+ * const rocket: Built = build({ rocket: "starship", variant: "v3" });
+ * console.log(rocket.shows.join(", "));
+ * console.log(rocket.boundsOf("together").max);
+ * ```
+ */
 export interface Built {
     report: FitReport;
     parts: readonly BuiltPart[];
@@ -44,14 +92,51 @@ export interface Built {
     /** The drawing, in a look, from an angle. */
     svg(options?: SvgOptions): string;
 }
-/** What a drawing draws of a part: in a stack, what nests inside the part below is out of sight. */
+/**
+ * What a drawing draws of a part: in a stack, what nests inside the part below is out of sight.
+ *
+ * @param part A built part: its record and its pieces.
+ * @param together True when the part stands in a stack, false when it is shown alone.
+ * @returns The pieces to draw. In a stack, what nests inside the part below is left out.
+ * @example
+ * ```ts
+ * import { build, drawnPieces } from "@johnmorrisdotca/uchusen-rockets/build";
+ *
+ * const [first] = build({ rocket: "falcon-9", variant: "block-5" }).parts;
+ * if (first) console.log(drawnPieces(first, true).length, drawnPieces(first, false).length);
+ * ```
+ */
 export declare function drawnPieces(part: {
     record: PartRecord;
     pieces: readonly Piece[];
 }, together: boolean): readonly Piece[];
-/** A rocket from a description. Throws FitError when it does not go together. */
+/**
+ * A rocket from a description. Throws FitError when it does not go together.
+ *
+ * @param description The rocket, its variant and any other part in a slot.
+ * @returns The built rocket. It throws a `FitError` when the description does not go together.
+ * @example
+ * ```ts
+ * import { build } from "@johnmorrisdotca/uchusen-rockets/build";
+ *
+ * const rocket = build({ rocket: "falcon-heavy" });
+ * console.log(rocket.report.label, rocket.glb().bytes.length > 1000);
+ * ```
+ */
 export declare function build(description: Description): Built;
-/** One part on its own, by its id. */
+/**
+ * One part on its own, by its id.
+ *
+ * @param id A part's id, as `PART_ENTRIES` lists it.
+ * @returns The part's record and bounds, a function for its `.glb` and one for its drawing. It throws for an id that is not a part.
+ * @example
+ * ```ts
+ * import { buildPart } from "@johnmorrisdotca/uchusen-rockets/build";
+ *
+ * const raptor = buildPart("raptor-vacuum");
+ * console.log(raptor.record.name, raptor.bounds.max);
+ * ```
+ */
 export declare function buildPart(id: string): {
     record: PartRecord;
     bounds: Bounds;

package/dist/build/index.js

@@ -9,7 +9,21 @@ import { plumeMarkup } from "../draw/plume.js";
 import { defsOf, drawPart, perspective } from "../draw/svg.js";
 import { bellsOf, litBells, pickBells, plumeLength } from "../engines.js";
 import { toGlb } from "./glb.js";
-/** Raised when a description does not fit: its report says why. */
+/**
+ * Raised by `build` when a description does not fit. Its `report` says why, in the same words `check` gives.
+ *
+ * @param report The report of the fit check that failed.
+ * @example
+ * ```ts
+ * import { build, FitError } from "@johnmorrisdotca/uchusen-rockets/build";
+ *
+ * try {
+ *   build({ rocket: "starship", variant: "v3", parts: { booster: "starship-v3-ship" } });
+ * } catch (error) {
+ *   if (error instanceof FitError) console.log(error.report.issues[0]?.message);
+ * }
+ * ```
+ */
 export class FitError extends Error {
     report;
     constructor(report) {
@@ -108,21 +122,58 @@ function assembled(report) {
         },
     };
 }
-/** What a drawing draws of a part: in a stack, what nests inside the part below is out of sight. */
+/**
+ * What a drawing draws of a part: in a stack, what nests inside the part below is out of sight.
+ *
+ * @param part A built part: its record and its pieces.
+ * @param together True when the part stands in a stack, false when it is shown alone.
+ * @returns The pieces to draw. In a stack, what nests inside the part below is left out.
+ * @example
+ * ```ts
+ * import { build, drawnPieces } from "@johnmorrisdotca/uchusen-rockets/build";
+ *
+ * const [first] = build({ rocket: "falcon-9", variant: "block-5" }).parts;
+ * if (first) console.log(drawnPieces(first, true).length, drawnPieces(first, false).length);
+ * ```
+ */
 export function drawnPieces(part, together) {
     const joint = part.record.joints.bottom?.y ?? 0;
     if (!together || joint <= 0)
         return part.pieces;
     return part.pieces.filter((piece) => !(piece.kind === "lathe" && piece.under && Math.max(...piece.profile.map(([, y]) => y)) <= joint + 0.01));
 }
-/** A rocket from a description. Throws FitError when it does not go together. */
+/**
+ * A rocket from a description. Throws FitError when it does not go together.
+ *
+ * @param description The rocket, its variant and any other part in a slot.
+ * @returns The built rocket. It throws a `FitError` when the description does not go together.
+ * @example
+ * ```ts
+ * import { build } from "@johnmorrisdotca/uchusen-rockets/build";
+ *
+ * const rocket = build({ rocket: "falcon-heavy" });
+ * console.log(rocket.report.label, rocket.glb().bytes.length > 1000);
+ * ```
+ */
 export function build(description) {
     const report = check(description);
     if (!report.ok)
         throw new FitError(report);
     return assembled(report);
 }
-/** One part on its own, by its id. */
+/**
+ * One part on its own, by its id.
+ *
+ * @param id A part's id, as `PART_ENTRIES` lists it.
+ * @returns The part's record and bounds, a function for its `.glb` and one for its drawing. It throws for an id that is not a part.
+ * @example
+ * ```ts
+ * import { buildPart } from "@johnmorrisdotca/uchusen-rockets/build";
+ *
+ * const raptor = buildPart("raptor-vacuum");
+ * console.log(raptor.record.name, raptor.bounds.max);
+ * ```
+ */
 export function buildPart(id) {
     const entry = partEntry(id);
     if (!entry)

package/dist/build/lineup.d.ts

@@ -1,6 +1,15 @@
 import { type ViewName } from "../framing.ts";
 import { type LookName } from "../looks.ts";
-/** Comparison shapes: plain round sizes, for scale, not facts about anything. */
+/**
+ * Comparison shapes: plain round sizes, for scale, not facts about anything.
+ *
+ * @example
+ * ```ts
+ * import { COMPARES } from "@johnmorrisdotca/uchusen-rockets/build";
+ *
+ * console.log(COMPARES.person.height, COMPARES.building.height);
+ * ```
+ */
 export declare const COMPARES: {
     readonly person: {
         readonly name: "A person, 1.8 m";
@@ -13,13 +22,46 @@ export declare const COMPARES: {
         readonly width: 18;
     };
 };
+/**
+ * The name of a comparison shape that can stand in a lineup: `person` or `building`.
+ *
+ * @example
+ * ```ts
+ * import type { CompareId } from "@johnmorrisdotca/uchusen-rockets/build";
+ *
+ * const id: CompareId = "person";
+ * console.log(id);
+ * ```
+ */
 export type CompareId = keyof typeof COMPARES;
+/**
+ * One thing standing in a lineup: its key (`starship:v3` or a comparison's name), its label and its height in metres.
+ *
+ * @example
+ * ```ts
+ * import { lineupSvg, type LineupItem } from "@johnmorrisdotca/uchusen-rockets/build";
+ *
+ * const items: LineupItem[] = lineupSvg({ items: ["starship:v3", "person"], unit: 3 }).items;
+ * console.log(items.map((item) => item.label));
+ * ```
+ */
 export interface LineupItem {
     /** "starship:v3" or a comparison's name. */
     key: string;
     label: string;
     height: number;
 }
+/**
+ * What a lineup is asked for: the items by key, how many pixels make a metre, and optionally the look, the view, what to show, a ruler and labels.
+ *
+ * @example
+ * ```ts
+ * import { lineupSvg, type LineupOptions } from "@johnmorrisdotca/uchusen-rockets/build";
+ *
+ * const options: LineupOptions = { items: ["starship:v2", "starship:v3", "building"], unit: 3, ruler: true, labels: true };
+ * console.log(lineupSvg(options).width);
+ * ```
+ */
 export interface LineupOptions {
     /** "starship:v1,starship:v3,person,building". */
     items: readonly string[];
@@ -31,7 +73,19 @@ export interface LineupOptions {
     ruler?: boolean;
     labels?: boolean;
 }
-/** The whole picture as SVG text. Unknown items are left out. */
+/**
+ * The whole picture as SVG text. Unknown items are left out.
+ *
+ * @param options The items and how they are drawn.
+ * @returns The picture as SVG text, the items it holds, and its width and height.
+ * @example
+ * ```ts
+ * import { lineupSvg } from "@johnmorrisdotca/uchusen-rockets/build";
+ *
+ * const picture = lineupSvg({ items: ["falcon-9:block-5", "falcon-heavy:falcon-heavy", "person"], unit: 4, ruler: true });
+ * console.log(picture.items.length, picture.svg.startsWith("<svg"));
+ * ```
+ */
 export declare function lineupSvg(options: LineupOptions): {
     svg: string;
     items: LineupItem[];

package/dist/build/lineup.js

@@ -6,7 +6,16 @@ import { DEFAULT_LOOK, LOOKS } from "../looks.js";
 import { defsOf, drawPart, orthographic } from "../draw/svg.js";
 import { MATERIALS } from "../model/materials.js";
 import { variantOf } from "../rockets.js";
-/** Comparison shapes: plain round sizes, for scale, not facts about anything. */
+/**
+ * Comparison shapes: plain round sizes, for scale, not facts about anything.
+ *
+ * @example
+ * ```ts
+ * import { COMPARES } from "@johnmorrisdotca/uchusen-rockets/build";
+ *
+ * console.log(COMPARES.person.height, COMPARES.building.height);
+ * ```
+ */
 export const COMPARES = {
     person: { name: "A person, 1.8 m", height: 1.8, width: 0.5 },
     building: { name: "A ten-storey building, 30 m", height: 30, width: 18 },
@@ -33,7 +42,19 @@ function comparison(id, x, base, unit, line, fill) {
         floors += `M${n(x)} ${n(base - (h * i) / 10)}h${n(w)}`;
     return `<rect x="${n(x)}" y="${n(base - h)}" width="${n(w)}" height="${n(h)}" fill="${fill}" stroke="${line}" stroke-width=".9"/><path d="${floors}" stroke="${line}" stroke-width=".35" opacity=".6"/>`;
 }
-/** The whole picture as SVG text. Unknown items are left out. */
+/**
+ * The whole picture as SVG text. Unknown items are left out.
+ *
+ * @param options The items and how they are drawn.
+ * @returns The picture as SVG text, the items it holds, and its width and height.
+ * @example
+ * ```ts
+ * import { lineupSvg } from "@johnmorrisdotca/uchusen-rockets/build";
+ *
+ * const picture = lineupSvg({ items: ["falcon-9:block-5", "falcon-heavy:falcon-heavy", "person"], unit: 4, ruler: true });
+ * console.log(picture.items.length, picture.svg.startsWith("<svg"));
+ * ```
+ */
 export function lineupSvg(options) {
     const { items, unit, look = DEFAULT_LOOK, view = "front", ruler = true, labels = true } = options;
     const angle = VIEWS[cleanView(view)];

package/dist/builder.d.ts

@@ -1,10 +1,32 @@
 import { type Description, type FitReport } from "./fit.ts";
+/**
+ * One part a row of the builder offers: its id, its name and the rocket it comes from.
+ *
+ * @example
+ * ```ts
+ * import { builderState, type BuilderOption } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * const first: BuilderOption | undefined = builderState().rows[0]?.options[0];
+ * console.log(first);
+ * ```
+ */
 export interface BuilderOption {
     id: string;
     name: string;
     /** Which rocket it comes from, to group a long list. */
     rocket: string;
 }
+/**
+ * One row of the builder, from the bottom: what it chooses, the parts it offers, the one chosen, and whether the builder made the choice because only one part fits.
+ *
+ * @example
+ * ```ts
+ * import { builderState, type BuilderRow } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * const row: BuilderRow | undefined = builderState().rows[0];
+ * console.log(row?.label, row?.chosen, row?.auto);
+ * ```
+ */
 export interface BuilderRow {
     /** What this row chooses. */
     label: string;
@@ -13,10 +35,34 @@ export interface BuilderRow {
     /** One answer only: the builder made the choice. */
     auto: boolean;
 }
+/**
+ * What the builder shows for a set of picks: its rows, the description they make and the fit report for it.
+ *
+ * @example
+ * ```ts
+ * import { builderState, type BuilderState } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * const state: BuilderState = builderState();
+ * console.log(state.rows.length, state.report.ok);
+ * ```
+ */
 export interface BuilderState {
     rows: readonly BuilderRow[];
     description: Description;
     report: FitReport;
 }
-/** The rows for these picks, from the bottom. A pick that is not offered, for a change lower down or a hostile value, gives way to the part that belongs with what is below, or else the first that fits. */
+/**
+ * The rows for these picks, from the bottom. A pick that is not offered, for a change lower down or a hostile value, gives way to the part that belongs with what is below, or else the first that fits.
+ *
+ * @param picks The part ids chosen so far, row by row from the bottom. Leave it out to start.
+ * @returns The rows to show, the description they make and its fit report.
+ * @example
+ * ```ts
+ * import { builderState } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * const start = builderState();
+ * const next = builderState([start.rows[0]?.chosen ?? ""]);
+ * console.log(next.description, next.report.label);
+ * ```
+ */
 export declare function builderState(picks?: readonly string[]): BuilderState;

package/dist/builder.js

@@ -24,7 +24,20 @@ const fitsOn = (part, below) => {
 };
 const REAL_PARTS = () => PART_ENTRIES.map(({ record }) => record).filter((record) => record.trueTo.length > 0);
 const optionOf = (part) => ({ id: part.id, name: part.name, rocket: ROCKETS[part.rocket]?.name ?? part.rocket });
-/** The rows for these picks, from the bottom. A pick that is not offered, for a change lower down or a hostile value, gives way to the part that belongs with what is below, or else the first that fits. */
+/**
+ * The rows for these picks, from the bottom. A pick that is not offered, for a change lower down or a hostile value, gives way to the part that belongs with what is below, or else the first that fits.
+ *
+ * @param picks The part ids chosen so far, row by row from the bottom. Leave it out to start.
+ * @returns The rows to show, the description they make and its fit report.
+ * @example
+ * ```ts
+ * import { builderState } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * const start = builderState();
+ * const next = builderState([start.rows[0]?.chosen ?? ""]);
+ * console.log(next.description, next.report.label);
+ * ```
+ */
 export function builderState(picks = []) {
     const every = framesOf();
     const parts = REAL_PARTS();

package/dist/crossfade.d.ts

@@ -1,6 +1,48 @@
-/** The drawing stays at least this long after it first comes on screen. */
+/**
+ * The drawing stays at least this long after it first comes on screen.
+ *
+ * @example
+ * ```ts
+ * import { DRAWING_HOLD_MS } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(DRAWING_HOLD_MS);
+ * ```
+ */
 export declare const DRAWING_HOLD_MS = 1200;
+/**
+ * How long the drawing and the 3D view cross-fade, in milliseconds.
+ *
+ * @example
+ * ```ts
+ * import { CROSSFADE_MS } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(CROSSFADE_MS);
+ * ```
+ */
 export declare const CROSSFADE_MS = 1500;
+/**
+ * How long the cross-fade lasts for a reader who asked for reduced motion, in milliseconds.
+ *
+ * @example
+ * ```ts
+ * import { REDUCED_FADE_MS } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(REDUCED_FADE_MS);
+ * ```
+ */
 export declare const REDUCED_FADE_MS = 400;
-/** How long to wait, once the 3D view is ready at `readyAt`, before it takes over from a drawing first seen at `shownAt` (0 under reduced motion). */
+/**
+ * How long to wait, once the 3D view is ready at `readyAt`, before it takes over from a drawing first seen at `shownAt` (0 under reduced motion).
+ *
+ * @param shownAt When the drawing first came on screen, in milliseconds.
+ * @param readyAt When the 3D view became ready, on the same clock.
+ * @param reducedMotion True when the reader asked for reduced motion.
+ * @returns The milliseconds to wait before the 3D view takes over.
+ * @example
+ * ```ts
+ * import { revealDelay } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(revealDelay(0, 300, false), revealDelay(0, 300, true));
+ * ```
+ */
 export declare function revealDelay(shownAt: number, readyAt: number, reducedMotion: boolean): number;

package/dist/crossfade.js

@@ -1,9 +1,51 @@
 // The change from a rocket's drawing to its 3D view: the drawing stays a moment even when the 3D view is ready sooner, then a slow crossfade; under reduced motion, a plain short fade. Pure.
-/** The drawing stays at least this long after it first comes on screen. */
+/**
+ * The drawing stays at least this long after it first comes on screen.
+ *
+ * @example
+ * ```ts
+ * import { DRAWING_HOLD_MS } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(DRAWING_HOLD_MS);
+ * ```
+ */
 export const DRAWING_HOLD_MS = 1200;
+/**
+ * How long the drawing and the 3D view cross-fade, in milliseconds.
+ *
+ * @example
+ * ```ts
+ * import { CROSSFADE_MS } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(CROSSFADE_MS);
+ * ```
+ */
 export const CROSSFADE_MS = 1500;
+/**
+ * How long the cross-fade lasts for a reader who asked for reduced motion, in milliseconds.
+ *
+ * @example
+ * ```ts
+ * import { REDUCED_FADE_MS } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(REDUCED_FADE_MS);
+ * ```
+ */
 export const REDUCED_FADE_MS = 400;
-/** How long to wait, once the 3D view is ready at `readyAt`, before it takes over from a drawing first seen at `shownAt` (0 under reduced motion). */
+/**
+ * How long to wait, once the 3D view is ready at `readyAt`, before it takes over from a drawing first seen at `shownAt` (0 under reduced motion).
+ *
+ * @param shownAt When the drawing first came on screen, in milliseconds.
+ * @param readyAt When the 3D view became ready, on the same clock.
+ * @param reducedMotion True when the reader asked for reduced motion.
+ * @returns The milliseconds to wait before the 3D view takes over.
+ * @example
+ * ```ts
+ * import { revealDelay } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(revealDelay(0, 300, false), revealDelay(0, 300, true));
+ * ```
+ */
 export function revealDelay(shownAt, readyAt, reducedMotion) {
     if (reducedMotion)
         return 0;

package/dist/data/credits.d.ts

@@ -1,3 +1,14 @@
+/**
+ * The credit for one licensed model: its title, its creator and their page, where it came from, its licence and what this package changed.
+ *
+ * @example
+ * ```ts
+ * import { MODEL_CREDITS, type ModelCredit } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * const credit: ModelCredit = MODEL_CREDITS["clarence365-block3"];
+ * console.log(credit.creator, credit.licence);
+ * ```
+ */
 export interface ModelCredit {
     title: string;
     creator: string;
@@ -8,6 +19,16 @@ export interface ModelCredit {
     /** What this package changed. */
     changes: string;
 }
+/**
+ * Every licensed model this package paints with, by credit id. A painted rocket must carry the credit of the parts that are showing; `embedCode` writes it for you.
+ *
+ * @example
+ * ```ts
+ * import { MODEL_CREDITS } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(Object.keys(MODEL_CREDITS).length > 10);
+ * ```
+ */
 export declare const MODEL_CREDITS: {
     readonly "clarence365-block3": {
         readonly title: "SpaceX Starship Block 3";
@@ -100,6 +121,28 @@ export declare const MODEL_CREDITS: {
     readonly "nasa-iss": ModelCredit;
     readonly "nasa-hubble": ModelCredit;
 };
+/**
+ * The id of one model's credit in `MODEL_CREDITS`.
+ *
+ * @example
+ * ```ts
+ * import type { CreditId } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * const id: CreditId = "clarence365-block3";
+ * console.log(id);
+ * ```
+ */
 export type CreditId = keyof typeof MODEL_CREDITS;
-/** One credit as a line of text. */
+/**
+ * One credit as a line of text.
+ *
+ * @param id The id of a credit in `MODEL_CREDITS`.
+ * @returns The credit as one line of text.
+ * @example
+ * ```ts
+ * import { creditLine } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(creditLine("clarence365-block3"));
+ * ```
+ */
 export declare function creditLine(id: CreditId): string;

package/dist/data/credits.js

@@ -11,6 +11,16 @@ const nasa = (title, slug, changes) => ({
     licenceUrl: "https://www.nasa.gov/nasa-brand-center/images-and-media/",
     changes,
 });
+/**
+ * Every licensed model this package paints with, by credit id. A painted rocket must carry the credit of the parts that are showing; `embedCode` writes it for you.
+ *
+ * @example
+ * ```ts
+ * import { MODEL_CREDITS } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(Object.keys(MODEL_CREDITS).length > 10);
+ * ```
+ */
 export const MODEL_CREDITS = {
     "clarence365-block3": {
         title: "SpaceX Starship Block 3",
@@ -104,7 +114,18 @@ export const MODEL_CREDITS = {
     "nasa-hubble": nasa("Hubble Space Telescope", "nasa-3d-models-hubble-space-telescope", "A lettered plate painted out of its picture; rescaled to the sourced length; its materials made into one picture."),
     // new rows go here
 };
-/** One credit as a line of text. */
+/**
+ * One credit as a line of text.
+ *
+ * @param id The id of a credit in `MODEL_CREDITS`.
+ * @returns The credit as one line of text.
+ * @example
+ * ```ts
+ * import { creditLine } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(creditLine("clarence365-block3"));
+ * ```
+ */
 export function creditLine(id) {
     const c = MODEL_CREDITS[id];
     return `"${c.title}" by ${c.creator} (${c.sourceUrl}), ${c.licence} (${c.licenceUrl}). ${c.changes}`;

package/dist/data/flight-log.d.ts

@@ -1,4 +1,15 @@
 import type { SourceId } from "./sources.ts";
+/**
+ * One flight from the flight log: its name, the rocket and variant that show it, the date, whether the launch succeeded, the source's own words on the outcome, and the source.
+ *
+ * @example
+ * ```ts
+ * import { FLIGHT_LOG, type LoggedFlight } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * const flight: LoggedFlight | undefined = FLIGHT_LOG[0];
+ * console.log(flight?.name, flight?.launch);
+ * ```
+ */
 export interface LoggedFlight {
     id: string;
     name: string;
@@ -13,6 +24,27 @@ export interface LoggedFlight {
     outcome: string;
     source: SourceId;
 }
+/**
+ * The flights this package keeps a record of, each from a named source. Use `flightLogOf` for one rocket.
+ *
+ * @example
+ * ```ts
+ * import { FLIGHT_LOG } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(FLIGHT_LOG.length > 0);
+ * ```
+ */
 export declare const FLIGHT_LOG: readonly LoggedFlight[];
-/** A rocket's flights, in order. */
+/**
+ * A rocket's flights, in order.
+ *
+ * @param rocket A rocket's id, such as `falcon-1`.
+ * @returns That rocket's logged flights, in order. It is empty for a rocket with none.
+ * @example
+ * ```ts
+ * import { flightLogOf } from "@johnmorrisdotca/uchusen-rockets";
+ *
+ * console.log(flightLogOf("falcon-1").map((flight) => flight.name));
+ * ```
+ */
 export declare const flightLogOf: (rocket: string) => readonly LoggedFlight[];