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 · Parsing, formatting and shared types

CleanAddressOptionstype

Options for cleanAddress: which tidying to do, and the letter case to set.

Import it

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

Definition

interface CleanAddressOptions extends AddressFormattingOptions {
    format?: "standard" | "usps" | "canada-post";
    removeExtraSpaces?: boolean;
    standardizeCase?: "upper" | "lower" | "title" | "none";
    expandAbbreviations?: boolean;
}

Members

NameTypeDescription
format (optional)"standard" | "usps" | "canada-post" | undefined
removeExtraSpaces (optional)boolean | undefined
standardizeCase (optional)"title" | "upper" | "lower" | "none" | undefined
expandAbbreviations (optional)boolean | undefined
includeCountry (optional)boolean | undefined
includeSecondaryUnit (optional)boolean | undefined
upperCase (optional)boolean | undefined
separator (optional)string | undefined
abbreviateStreetTypes (optional)boolean | undefined
abbreviateDirections (optional)boolean | undefined
abbreviateStates (optional)boolean | undefined
usePlusCode (optional)boolean | undefined

Examples

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

console.log(cleanAddress("123 main st, anytown, ny 12345", { standardizeCase: "upper" }));
// → "123 MAIN ST, ANYTOWN NY 12345"
123 MAIN ST, ANYTOWN NY 12345

What it prints (run when this page was built)

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