Reference
The small first chunk of the names index: the 335 stars with a common name and the 110 Messier objects, the same rows as the full index, for a search box that loads about 20 kB first
import { … } from "@johnmorrisdotca/hoshi-stars/names/named";22.7 kB minified and gzipped, with everything it imports (measured with esbuild)
Exports
| Name | Kind | What it is |
|---|---|---|
deepSkyRow | function | The row of a deep-sky object. |
findName | function | The row of the small chunk that a name, a designation or an id names exactly, ignoring case, spacing, accents and the Greek letter's spelling (Betelgeuse, alpha Ori, HR 2061, M31, NGC 224, ベテルギウス), or undefined. |
NAME_KINDS | constant | The kinds of row in the names index: star, cluster (open and globular), nebula (emission, reflection, planetary, supernova remnant), galaxy and other (an asterism, a double star Messier listed, a source that is none of those). |
nameIndex | function | An index over rows: by id, by exact name and by a ranked search. |
NameIndex | type | What an index of rows offers: the rows, one by id, one by any name, and a ranked search. |
nameKey | function | A text folded to compare, as findName does: lower case, no accents, Greek letters spelt out and one space, a superscript as its digit; M 31, Messier 31 and m31 give m31, NGC 0224 gives ngc224, HR 2061 and hr2061 give hr2061. |
NameKind | type | One kind of row: star, cluster, nebula, galaxy or other. |
NameRow | type | One row of the names index: a star or a deep-sky object with the names a search box would try, and where to turn the sky to it. |
nameRowById | function | One row of the small chunk by its id (betelgeuse, m31): the same row /names gives for that id; undefined for a star without a common name (alpha-centauri, hr-1234), which is in /names. |
nameRows | function | The rows of the small chunk: the 335 stars with a common name and the 110 Messier objects (445), brightest and best-known first (by weight), as a fresh array. |
searchNames | function | The rows of the small chunk whose names match what was typed: those with a name that starts with it first (an exact name before those), then those that contain it, each by weight. |
slugOf | function | An address-safe id from a text: lower-case ASCII letters and digits in runs joined by one hyphen; an accent is dropped (Boötes gives bootes) and a Greek letter is spelt out (α1 Centauri gives alpha1-centauri). |