本文へ移動

address-plusアドレスプラス

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

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

目次

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

AddressFormattingOptions型

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

Options for formatAddress and cleanAddress: what to abbreviate, capitals, the unit, the country and the line separator.

インポート

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

定義

interface AddressFormattingOptions {
    includeCountry?: boolean;
    includeSecondaryUnit?: boolean;
    upperCase?: boolean;
    separator?: string;
    abbreviateStreetTypes?: boolean;
    abbreviateDirections?: boolean;
    abbreviateStates?: boolean;
    usePlusCode?: boolean;
}

メンバー

名前型説明
includeCountry (省略可)boolean | undefined
includeSecondaryUnit (省略可)boolean | undefined
upperCase (省略可)boolean | undefined
separator (省略可)string | undefined
abbreviateStreetTypes (省略可)boolean | undefined
abbreviateDirections (省略可)boolean | undefined
abbreviateStates (省略可)boolean | undefined
usePlusCode (省略可)boolean | undefined

例

import { formatAddress, parseLocation } from "@johnmorrisdotca/address-plus";
import type { AddressFormattingOptions } from "@johnmorrisdotca/address-plus";

const parsedAddress1=parseLocation("123 Main Street, Anytown, NY 12345");
if (!parsedAddress1) throw new Error("The example address did not parse.");
console.log(formatAddress(parsedAddress1, { upperCase: true }).singleLine);
// → "123 MAIN ST, ANYTOWN NY 12345"
123 MAIN ST, ANYTOWN NY 12345

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

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

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