/uk_postcode

UK postcode parsing and validation for Elixir

Primary LanguageElixirMIT LicenseMIT

UK Postcode

Build Status Hex Version Inline docs

UK postcode parsing and validation for Elixir. Based on the excellent Ruby library of the same name by @threedaymonk.

Usage

Validate full postcodes or parts of a postcode.

UKPostcode.valid? "W1A 1AA" #=> true
UKPostcode.full? "W1A 1AA"  #=> true
UKPostcode.outcode? "W1A"   #=> true

Extract parts of a full postcode.

UKPostcode.outcode "W1A 1AA" #=> "W1A"
UKPostcode.incode "W1A 1AA"  #=> "1AA"

Normalise badly formatted postcodes.

UKPostcode.normalise "w1a1aa"  #=> "W1A 1AA"