Skip to the content

address-plusアドレスプラス

Parse, validate, format and compare addresses locally, add country modules and mount an optional native form field.

address-plus extends the parse-address style with typed results, validation, formatting and country modules. About the name

Contents

Reference · Australian country module

CountryModuletype

A country's address module: its codes, how to tell its addresses apart, and its parser, validator, formatter and comparer. Import one from its entry point (australia from @johnmorrisdotca/address-plus/au, unitedKingdom from @johnmorrisdotca/address-plus/gb) and hand it to parseLocation and validateAddress in countries.

Import it

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

Also exported from: @johnmorrisdotca/address-plus/gb, @johnmorrisdotca/address-plus/de, @johnmorrisdotca/address-plus/fr, @johnmorrisdotca/address-plus

Definition

interface CountryModule {
    code: string;
    codes: readonly string[];
    name: string;
    detect(address: string): boolean;
    parse(address: string, options?: ParseOptions): ParsedAddress | null;
    validate(address: ParsedAddress, options?: ValidationOptions): CountryValidation;
    format(address: ParsedAddress): FormattedAddress;
    compare(first: ParsedAddress, second: ParsedAddress): CountryComparison;
}

Members

NameTypeDescription
codestring
codesreadonly string[]
namestring
detect(address: string): boolean
parse(address: string, options?: ParseOptions): ParsedAddress | null
validate(address: ParsedAddress, options?: ValidationOptions): CountryValidation
format(address: ParsedAddress): FormattedAddress
compare(first: ParsedAddress, second: ParsedAddress): CountryComparison

Examples

import { australia } from "@johnmorrisdotca/address-plus/au";
import type { CountryModule } from "@johnmorrisdotca/address-plus/au";

console.log(australia.codes);
// → ["AU"]
[ 'AU' ]

What it prints (run when this page was built)

View sourceEdit on GitHubMade from the source of @johnmorrisdotca/address-plus 1.7.0.