Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface City

A City object would store the information about the resolved area.

Hierarchy

  • City

Indexable

[key: string]: unknown

A catch-all property

Index

Properties

city: string

The name of the city. The county name may precede it, or the name of the ward would follow it in case the city has ordinance-designated wards.

Examples:

  • "港区"
  • "大阪市北区"
  • "各務原市"
  • "秩父郡長瀞町"
city_code: string

The remaining portion of the JISX0402 code that has the leading two-dight prefecture code removed.

Example: "113"

city_kana: string

The reading of the name of the city in katakana.

Examples:

  • "ミナトク"
  • "オオサカシキタク"
  • "カカミガハラシ"
  • "チチブグンナガトロマチ"
city_roman?: string

The "romanized" reading of the name of the city.

Examples:

  • "Minato-ku"
  • "Kita-ku, Osaka"
  • "Kakamigahara"
  • "Nagatoro, Chichibu"
jisx0402: string

The 5 digit Japanese municipality code (全国地方公共団体コード) for the administrative division this object represents.

prefecture: string

The name of the prefecture in Kanji.

Example: "東京都"

prefecture_code: string

The prefecture code defined in JISX0401.

Example: "13"

prefecture_kana: string

The reading of the name of the prefecture in katakana.

Example: "トウキョウト"

prefecture_roman?: string

The "romanized" reading of the name of the prefecture.

Example: "Tokyo"

Generated using TypeDoc