本文へ移動

address-plusアドレスプラス

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

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

目次

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

parsePostalCode関数

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

Takes a ZIP code, ZIP+4 or Canadian postal code off the end of a text.

インポート

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

定義

function parsePostalCode(text: string): { zip: string | undefined; plus4: string | undefined; remaining: string; detectedCountry?: "US" | "CA"; detectedProvince?: string; }

引数

名前型説明
textstring

The text, such as Toronto ON M5H 2N2.

戻り値

{ zip: string | undefined; plus4: string | undefined; remaining: string; detectedCountry?: "US" | "CA"; detectedProvince?: string; }

The code and its ZIP+4 (undefined when there is none), the text that remains, and the country and province the code points to.

例

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

console.log(parsePostalCode("Toronto ON M5H 2N2"));
// → {"zip":"M5H 2N2","remaining":"Toronto ON","detectedCountry":"CA","detectedProvince":"ON"}
{
  zip: 'M5H 2N2',
  plus4: undefined,
  remaining: 'Toronto ON',
  detectedCountry: 'CA',
  detectedProvince: 'ON'
}

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

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

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