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 · British country module

validateUKAddressfunction

Checks an address in the United Kingdom against Royal Mail's postcode grammar and the tables: the postcode is well formed, Royal Mail uses its area, and in Great Britain Code-Point Open lists its district. Says when a postcode is Jersey's, Guernsey's or the Isle of Man's, which are not part of the UK, and warns when the postcode or the post town is missing.

Import it

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

Definition

function validateUKAddress(address: ParsedAddress, options?: ValidationOptions): CountryValidation

Parameters

NameTypeDescription
addressParsedAddress

The address as parseUKAddress (or parseLocation with the module) returns it.

options (optional)ValidationOptions

strictPostalValidation: true makes the postcode findings errors; the rest are not used.

Returns

CountryValidation

The errors and warnings, each with its field, code and message.

Examples

import { parseUKAddress, validateUKAddress } from "@johnmorrisdotca/address-plus/gb";

const parsedAddress1=parseUKAddress("1 High Street, London EC9Z 1AA");
if (!parsedAddress1) throw new Error("The example address did not parse.");
console.log(validateUKAddress(parsedAddress1).warnings.map((one) => one.code));
// → ["INVALID_POSTAL_FORMAT"]
[ 'INVALID_POSTAL_FORMAT' ]

What it prints (run when this page was built)

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