本文へ移動

address-plusアドレスプラス

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

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

目次

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

formatCanadaPost関数

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

Writes a parsed address the way Canada Post asks: capitals, the unit before the civic number joined by a hyphen, and the postal code two spaces after the province.

インポート

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

定義

function formatCanadaPost(address: ParsedAddress, options?: CanadaPostFormattingOptions): FormattedAddress

引数

名前型説明
addressParsedAddress

The address, as parseLocation returns it.

options (省略可)CanadaPostFormattingOptions

Canada Post settings (see CanadaPostFormattingOptions).

戻り値

FormattedAddress

The address as lines and as one line.

例

import { formatCanadaPost, parseLocation } from "@johnmorrisdotca/address-plus";

const parsedAddress1=parseLocation("100 Queen Street West, Toronto, Ontario M5H 2N2");
if (!parsedAddress1) throw new Error("The example address did not parse.");
console.log(formatCanadaPost(parsedAddress1).lines);
// → ["100 QUEEN ST W","TORONTO ON M5H 2N2"]
[ '100 QUEEN ST W', 'TORONTO ON  M5H 2N2' ]

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

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

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