Reference · British country module
formatRoyalMailfunction
Writes an address in the United Kingdom as Royal Mail asks: the flat or part of the building, the floor, the
building's name, the number with the dependent thoroughfare or the thoroughfare, the localities, then the post town
and the postcode in capitals, each on its own line. A forces address ends BFPO 105.
Import it
import { formatRoyalMail } from "@johnmorrisdotca/address-plus/gb";Definition
function formatRoyalMail(address: ParsedAddress, options?: RoyalMailFormattingOptions): FormattedAddressParameters
| Name | Type | Description |
|---|---|---|
address | ParsedAddress | The address as |
options (optional) | RoyalMailFormattingOptions | Whether to keep a county and to add the country (see |
Returns
FormattedAddress
The lines, the same on one line, the delivery line (the number and thoroughfare) and the last line.
Examples
import { formatRoyalMail, parseUKAddress } from "@johnmorrisdotca/address-plus/gb";
const parsedAddress1=parseUKAddress("Flat 2, Rose Court, 14 High St, Kingsbury, London NW9 0AA");
if (!parsedAddress1) throw new Error("The example address did not parse.");
console.log(formatRoyalMail(parsedAddress1).lines);
// → ["Flat 2","Rose Court","14 High Street","Kingsbury","LONDON","NW9 0AA"][
'Flat 2',
'Rose Court',
'14 High Street',
'Kingsbury',
'LONDON',
'NW9 0AA'
]What it prints (run when this page was built)