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

validateFrenchAddressfunction

Checks an address in France against La Poste's postcode shape and the tables: the postcode is five digits, its number names a department, a collectivity or Monaco, and La Poste's base officielle lists it. Says when a postcode is Monaco's or an overseas collectivity's, which have country codes of their own, and warns when the postcode or the commune is missing.

Import it

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

Definition

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

Parameters

NameTypeDescription
addressParsedAddress

The address as parseFrenchAddress (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 { parseFrenchAddress, validateFrenchAddress } from "@johnmorrisdotca/address-plus/fr";

const parsedAddress1=parseFrenchAddress("12 rue de la Paix, 75099 Paris");
if (!parsedAddress1) throw new Error("The example address did not parse.");
console.log(validateFrenchAddress(parsedAddress1).warnings.map((one) => one.code));
// → ["UNRECOGNIZED_POSTAL_CODE"]
[ 'UNRECOGNIZED_POSTAL_CODE' ]

What it prints (run when this page was built)

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