PlaceCities型
リファレンスの説明と例は英語です。見出しと目次は日本語です。
The city lists for placeOf. The three tiers here-city loads (capitals, a million, 100,000) match this.
towns is read only when the caller passes it, and only for the one or two countries those tiers name, the same rule as here-city.
インポート
import type { PlaceCities } from "@johnmorrisdotca/chikyu-earth/place";
定義
interface PlaceCities {
nearest(point: {
lat: number;
lon: number;
}, options?: {
maxKm?: number;
}): {
city: {
id: string;
name: {
en: string;
ja?: string;
jaShort?: string;
};
country?: string;
lat?: number;
lon?: number;
};
km: number;
} | null;
within?(point: {
lat: number;
lon: number;
}, maxKm: number): readonly {
city: {
country?: string;
};
km: number;
}[];
}
メンバー
| 名前 | 型 | 説明 |
|---|---|---|
nearest | (point: { lat: number; lon: number; }, options?: { maxKm?: number; }): { city: { id: string; name: { en: string; ja?: string; jaShort?: string; }; country?: string; lat?: number; lon?: number; }; km: number; } | null | |
within (省略可) | ((point: { lat: number; lon: number; }, maxKm: number) => readonly { city: { country?: string; }; km: number; }[]) | undefined |
例
import type { PlaceCities } from "@johnmorrisdotca/chikyu-earth/place";
const cities: PlaceCities = { nearest: () => null };
console.log(cities.nearest({ lat: 0, lon: 0 }));null出力(このページを作ったときに実行した結果)
この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。