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

UKPostcodetype

A postcode taken apart: the outward code (area and district) and the inward code (sector and unit), and where it delivers. country is GB for the United Kingdom and JE, GY or IM for Jersey, Guernsey and the Isle of Man, which use Royal Mail's postcodes but are not part of the United Kingdom.

Import it

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

Also exported from: @johnmorrisdotca/address-plus

Definition

interface UKPostcode {
    postcode: string;
    outward: string;
    inward: string;
    area: string;
    district: string;
    sector: string;
    country: "GB" | "GY" | "IM" | "JE";
    nation?: UKNationCode;
}

Members

NameTypeDescription
postcodestring
outwardstring
inwardstring
areastring
districtstring
sectorstring
country"GB" | "GY" | "IM" | "JE"
nation (optional)UKNationCode | undefined

Examples

import { parseUKPostcode } from "@johnmorrisdotca/address-plus/gb";
import type { UKPostcode } from "@johnmorrisdotca/address-plus/gb";

console.log(parseUKPostcode("ec1a1bb"));
// → {"postcode":"EC1A 1BB","outward":"EC1A","inward":"1BB","area":"EC","district":"EC1A","sector":"EC1A 1","country":"GB","nation":"ENG"}
{
  postcode: 'EC1A 1BB',
  outward: 'EC1A',
  inward: '1BB',
  area: 'EC',
  district: 'EC1A',
  sector: 'EC1A 1',
  country: 'GB',
  nation: 'ENG'
}

What it prints (run when this page was built)

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