parseUKAddressfunction

Parses an address in the United Kingdom (or Jersey, Guernsey and the Isle of Man, which share Royal Mail's postcodes) into the parts of Royal Mail's Postcode Address File: a flat or unit (secUnitType, secUnitNum) or a named part of a building (subBuilding), a floor, the building's name, the number, a dependent thoroughfare, the thoroughfare (its name in street, its descriptor in full in type), the dependent localities, the post town in city, a county, and the postcode in zip with the nation it delivers to. The postcode is found wherever it is written and normalised to capitals with one space; BFPO 105 is read as a forces address.

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

function parseUKAddress(text: string, options?: ParseOptions): ParsedAddress | null

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

console.log(parseUKAddress("Flat 14, Ziggurat Building, 60-66 Saffron Hill, London EC1N 8QX"));
// → {"secUnitType":"Flat","secUnitNum":"14","building":"Ziggurat Building","number":"60-66","street":"Saffron","type":"Hill","city":"London","zip":"EC1N 8QX","zipValid":true,"nation":"ENG","country":"GB"}

{
  secUnitType: 'Flat',
  secUnitNum: '14',
  building: 'Ziggurat Building',
  number: '60-66',
  street: 'Saffron',
  type: 'Hill',
  city: 'London',
  zip: 'EC1N 8QX',
  zipValid: true,
  nation: 'ENG',
  country: 'GB'
}