本文へ移動

address-plusアドレスプラス

住所を端末の中で解析・確認・整形・比較し、国のモジュールや任意のフォームの入力欄を使えます。

address-plusは、parse-addressの使い方を広げ、型付きの結果、確認、書式、国のモジュールを加えます。 名前について(英語)

目次

リファレンス · 日本の住所

JapaneseFormattingOptions型

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

Options for formatJapanese.

インポート

import type { JapaneseFormattingOptions } from "@johnmorrisdotca/address-plus/jp";

ほかのエクスポート元: @johnmorrisdotca/address-plus

定義

interface JapaneseFormattingOptions {
    blockStyle?: "hyphen" | "markers";
    includePostalCode?: boolean;
    multiline?: boolean;
}

メンバー

名前型説明
blockStyle (省略可)"hyphen" | "markers" | undefined
includePostalCode (省略可)boolean | undefined
multiline (省略可)boolean | undefined

例

import { formatJapanese } from "@johnmorrisdotca/address-plus/jp";
import { parseLocation } from "@johnmorrisdotca/address-plus";
import type { JapaneseFormattingOptions } from "@johnmorrisdotca/address-plus/jp";

const parsedAddress1=parseLocation("〒100-0005 東京都千代田区丸の内1-2-3");
if (!parsedAddress1) throw new Error("The example address did not parse.");
console.log(formatJapanese(parsedAddress1, { blockStyle: "markers", includePostalCode: false }));
// → "東京都千代田区丸の内1丁目2番3号"
東京都千代田区丸の内1丁目2番3号

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

ソースを見るGitHub で編集@johnmorrisdotca/address-plus 1.7.0 のソースから作成しました。

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