本文へ移動

address-plusアドレスプラス

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

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

目次

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

BatchParseStats型

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

The counts and timing of a batch: how many were parsed, how many failed, and how long it took.

インポート

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

定義

interface BatchParseStats {
    total: number;
    successful: number;
    failed: number;
    duration: number;
    averagePerAddress: number;
    addressesPerSecond: number;
}

メンバー

名前型説明
totalnumber
successfulnumber
failednumber
durationnumber
averagePerAddressnumber
addressesPerSecondnumber

例

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

console.log(parseLocationsBatch(["123 Main St, Anytown, NY 12345", ""]).stats.failed);
// → 1
1

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

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

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