Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 1.01 KB

README.md

File metadata and controls

38 lines (28 loc) · 1.01 KB
Raw

postcode-spec

Clojars Project

Validates and generates UK postcodes in accordance with https://en.wikipedia.org/wiki/Postcodes_in_the_United_Kingdom

Usage

(require '[postcode-spec.core :as postcode])

(comment
  (s/conform ::postcode/united-kingdom-postcode "XM45HQ")
  ;; => :clojure.spec.alpha/invalid

  (s/conform ::postcode/united-kingdom-postcode "XM4 5HQ")
  ;; => "XM4 5HQ"

  (gen/sample (s/gen ::postcode/united-kingdom-postcode))
  ;; => ("A0A 1BB"
  ;;     "AB0A 0BA"
  ;;     "BA1B 1AB"
  ;;     "C0B 0DB"
  ;;     "BB2 1BB"
  ;;     "EA15 5BA"
  ;;     "N6D 1TG"
  ;;     "G5B 5IQ"
  ;;     "B1A 1DC"
  ;;     "IB6A 5AB")
  )

Status

CircleCI

License

Distributed under the Eclipse Public License either version 1.0 or (at your option) any later version.