`PassOptions`型

リファレンスの説明と例は英語です。見出しと目次は日本語です。

What findPasses may be asked.

インポート

import type { PassOptions } from "@johnmorrisdotca/chikyu-earth/passes";

定義

interface PassOptions {
    minAltitude?: number;
    sky?: Exclude<SkyName, "day">;
    all?: boolean;
    limitingMagnitude?: number;
    magnitudes?: Readonly<Record<number, number>>;
    maxAgeDays?: number;
}

メンバー

名前	型	説明
`minAltitude` (省略可)	`number \| undefined`	The lowest altitude, degrees, at which a pass counts as begun and ended (10 by default, as sky-watchers' tables use: below it there are trees, buildings and haze).
`sky` (省略可)	`"night" \| "civil" \| "nautical" \| "astronomical" \| undefined`	The lightest sky a watcher may be in for a pass to count as visible: `civil` (the default: twilight or darker), `nautical`, `astronomical` or `night`.
`all` (省略可)	`boolean \| undefined`	List every pass, with the reason it cannot be seen, and not only the visible ones (false by default).
`limitingMagnitude` (省略可)	`number \| undefined`	A satellite fainter than this (a larger magnitude) counts as not visible (4 by default: a suburban sky). Only when the satellite's standard magnitude is known.
`magnitudes` (省略可)	`Readonly<Record<number, number>> \| undefined`	Standard magnitudes by NORAD number, added to (and over) `STANDARD_MAGNITUDES`.
`maxAgeDays` (省略可)	`number \| undefined`	Elements older than this many days at a pass leave the pass out (30 by default, `DEFAULT_MAX_AGE_DAYS`).

例

import type { PassOptions } from "@johnmorrisdotca/chikyu-earth/passes";

const options: PassOptions = { minAltitude: 10, sky: "civil", all: false };
console.log(options.minAltitude);

出力（このページを作ったときに実行した結果）

ソースを見る GitHub で編集@johnmorrisdotca/chikyu-earth 0.51.1 のソースから作成しました。

この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。

PassOptions型

定義

メンバー

例

`PassOptions`型