registerStarLook関数
リファレンスの説明と例は英語です。見出しと目次は日本語です。
Teach the package a star by name, so an element can be told star="Betelgeuse" and draw it from these numbers. The package holds no catalogue of stars: this is where a page puts the few it draws.
The name is matched without regard to case. Registering a name again replaces it.
インポート
import { registerStarLook } from "@johnmorrisdotca/wakusei-planets/look";
定義
function registerStarLook(name: string, numbers: StarNumbers): StarLook
引数
| 名前 | 型 | 説明 |
|---|---|---|
name | string | What the star is called in the |
numbers | StarNumbers | The star's numbers. |
戻り値
StarLook
The star, ready to draw.
例
import { registerStarLook, starLookOf } from "@johnmorrisdotca/wakusei-planets/look";
registerStarLook("Proxima Centauri", { temperatureK: 3042, radiusSun: 0.154, luminosityClass: "V", rotationDays: 83 });
console.log(starLookOf("proxima centauri")?.colour);#ffb371出力(このページを作ったときに実行した結果)
この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。