本文へ移動

address-plusアドレスプラス

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

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

目次

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

cleanAddressDetailed関数

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

Tidies an address like cleanAddress, and says what it changed.

インポート

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

定義

function cleanAddressDetailed(addressString: string, options?: CleanAddressOptions): CleanAddressResult

引数

名前型説明
addressStringstring

The address as typed.

options (省略可)CleanAddressOptions

What to tidy and the letter case to set (see CleanAddressOptions).

戻り値

CleanAddressResult

The tidied address, the input, whether anything changed, and a line for each change.

例

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

console.log(cleanAddressDetailed("742 evergreen terrace,springfield ,  il 62704").cleanedAddress);
// → "742 Evergreen Ter, Springfield IL 62704"
742 Evergreen Ter, Springfield IL 62704

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

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

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