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

getNationFromUKPostcodefunction

The nation of the United Kingdom a postcode delivers to, by its area, or by its district where the district crosses the border with Wales or with Scotland (the nation most of its postcodes are in).

Import it

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

Definition

function getNationFromUKPostcode(postcode: string): UKNationCode | undefined

Parameters

NameTypeDescription
postcodestring

The postcode.

Returns

UKNationCode | undefined

ENG, NIR, SCT or WLS; undefined for a postcode outside the United Kingdom, one that is not a place (BFPO), or text that is not a postcode.

Examples

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

console.log(["CH5 1AA", "BT1 1AA", "EH1 1YZ", "JE2 3AB"].map(getNationFromUKPostcode));
// → ["WLS","NIR","SCT",null]
[ 'WLS', 'NIR', 'SCT', undefined ]

What it prints (run when this page was built)

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