Reference · Facts, line drawings and positions
lineupBodiesfunction
What the line-up draws for some choices, smallest first: the stars of a set (or the ids of your own list) and, with planets, the Earth and Jupiter. The radius of a planet is its equatorial radius from the package's facts.
An id that is not in the table throws a RangeError.
Import it
import { lineupBodies } from "@johnmorrisdotca/wakusei-planets";
Definition
function lineupBodies(options?: { set?: LineupSet | readonly string[]; planets?: boolean; }): LineupBody[]
Parameters
| Name | Type | Description |
|---|---|---|
options (optional) | { set?: LineupSet | readonly string[]; planets?: boolean; } |
|
Returns
LineupBody[]
The bodies, ordered by radius.
Examples
import { lineupBodies } from "@johnmorrisdotca/wakusei-planets";
console.log(lineupBodies({ set: "bright", planets: true }).map((body) => body.id).join(", "));earth, jupiter, sun, sirius-a, vega, arcturus, aldebaran, rigel, antares, betelgeuseWhat it prints (run when this page was built)