jp-local-gov v1.7.0

jp-local-gov

npm install jp-local-gov

機能一覧

都道府県

prefectureNames: string[]

「北海道」「東京都」「大阪府」のように、都道府県の名前を、JIS X 0401 で定められている都道府県コードの順番で収録した配列です。

prefectureNamesWithoutSuffix: string[]

「北海道」「東京」「大阪」のように、通常「北海道」としか呼ばれない北海道以外の都府県について、「都府県」の接尾辞を抜いた都道府県の名前を、JIS X 0401 で定められている都道府県コードの順番で収録した配列です。

prefectureIds: string[]

都道府県を漢字で管理するのには様々な不都合がありえるため、扱いやすい英字での ID を別途用意しています。ローマ字表記には表記ゆれがありえますが (gunma, gumma 等)、各都道府県のウェブサイトの URL から抜き出したものを採用しています。

prefecturalWebsites: {id: string}

各都道府県のウェブサイトの URL (正確には「オリジン」) を収録したオブジェクトです。理想的には https://www.pref.{都道府県ID}.lg.jp/ の形式ですが、 .lg.jp ドメインを採用せず単に .jp ドメインを使用している都道府県も複数存在しています。このオブジェクトを利用することで、たとえば Google 検索で site:https://www.pref.gunma.jp/ と指定して県公式データのみを検索するといった活用ができます。

adjacentPrefectures: {id: id[]}

国土交通省が発注者支援業務等民間競争入札実施要項で用いている、橋梁及びトンネルでの隣接を含む地続きの隣接都道府県のデータを元としたオブジェクトです。

getPrefectureName(name[, removeSuffix: boolean]): string

上述の都道府県 ID を都道府県名に変換します。

getPrefectureId(id): string

都道府県名を上述の都道府県 ID に変換します。「都府県」の有無の双方に対応しています。

衆議院

getShuDistrictCounts(date: string[, sort='legally' | 'by-vote-day']): {pref: number}

日付を指定することで、その日付現在の、都道府県とその小選挙区の個数の対応を示すオブジェクトを返します。

小選挙区の数は公職選挙法の改正により変わりますが、実際の選挙での小選挙区の個数の変化は、法改正の施行のタイミングと一致するとは限りません。補欠選挙においては、旧区割りで実施されると定められています。そのため、「法的な現在の数」と「いま補欠選挙が行われた場合の数」のどちらが欲しいか、区別する必要があります。

原理主義的には「法的な現在の数」をデフォルトとしたいところですが、実用的には「いま補欠選挙が行われた場合の数」が知りたいことが圧倒的に多いため、そちらをデフォルト値としています。

blockNames

blockPrefectures

全国地方公共団体コード

総務省が定めている「全国地方公共団体コード」のための機能群です。JIS X 0401 で定められている2桁の都道府県コード、JIS X 0402 で定められている3桁の市区町村コードと、検査数字1桁から成ります。

allCodes: Object

ソースにもなっている、全コードの情報です。

verifyCheckDigit(code): bool

6桁の全国地方公共団体コードの検査数字が正常かどうかを返す関数です。

getCodeInfo(code): Object

6桁の全国地方公共団体コードから、その地方公共団体の情報 (コード、名前、読みかな、上位/下位の都道府県/市区町村) を返す関数です。

searchCodeInfo(word): Object

「沼津市」「東京都北区」などのクエリを引数にとり、データベース (ローカルの JSON ファイル) から一致するものを検索し、その地方公共団体の情報 (コード、名前、読みかな、上位/下位の都道府県/市区町村) を返す関数です。

地域メッシュコード

JIS X 0410 で定められている「地域メッシュコード」のための機能群です。業界でみられる様々な非標準拡張にも対応しています。

coordinateToMeshCode(coordinate[, degree]): string

座標をメッシュコードに変換します。

第1引数には座標を 緯度, 経度 もしくは 経度, 緯度 の形式で与えます。

座標の緯度経度をどの順番で指定するかは大きなサービス間でもはっきりと統一されていません。ISO 6709 では 緯度, 経度 の順と定義されており、Google Maps や JIS X 0410 など、この順番を遵守しているものがやや多い印象ですが、たとえば GeoJSON (RFC 7841) では 経度, 緯度 の順で座標を記述します。「地域メッシュコード」は日本国土のみ (北緯24 - 46度、東経122 - 149度範囲) を対象としているため、幸い順番の推測が可能ですから、このライブラリは両方の順番に対応しています。

第2引数には所望のメッシュ種類を指定します。省略した場合、基準地域メッシュコードとなります。