本文へ移動

address-plusアドレスプラス

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

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

目次

リファレンス · 解析・書式・共通の型

USPSFormattingOptions型

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

Options for formatUSPS: which lines to include, and whether to set the letter case the USPS way.

インポート

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

定義

interface USPSFormattingOptions {
    includeDeliveryLine?: boolean;
    includeLastLine?: boolean;
    includeBarcode?: boolean;
    standardizeCase?: boolean;
}

メンバー

名前型説明
includeDeliveryLine (省略可)boolean | undefined
includeLastLine (省略可)boolean | undefined
includeBarcode (省略可)boolean | undefined
standardizeCase (省略可)boolean | undefined

例

import { formatUSPS, parseLocation } from "@johnmorrisdotca/address-plus";
import type { USPSFormattingOptions } from "@johnmorrisdotca/address-plus";

const parsedAddress1=parseLocation("123 Main St, Anytown, NY 12345");
if (!parsedAddress1) throw new Error("The example address did not parse.");
console.log(formatUSPS(parsedAddress1, { includeLastLine: false }).lines);
// → ["123 MAIN ST"]
[ '123 MAIN ST' ]

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

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

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