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

isValidAddressfunction

Whether an address passes validateAddress.

Import it

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

Definition

function isValidAddress(addressString: string, options?: ValidationOptions): boolean

Parameters

NameTypeDescription
addressStringstring

The address as one string.

options (optional)ValidationOptions

What to require and how strict to be (see ValidationOptions).

Returns

boolean

true when it has no errors, false otherwise. Warnings do not make it invalid unless strictPostalValidation turns them into errors.

Examples

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

console.log(isValidAddress("123 Main St, Seattle, NY 98101", { strictPostalValidation: true }));
// → false
false

What it prints (run when this page was built)

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