Skip to content

README.md

Latest commit

 

History

History
32 lines (23 loc) · 1006 Bytes

README.md

File metadata and controls

32 lines (23 loc) · 1006 Bytes

uk-postcode

Node.js module for parsing and validating UK postcodes.

Install

npm install uk-postcode

Usage

var ukPostcode = require("uk-postcode");
var postcode = ukPostcode.fromString("M11AA");
if (postcode.isValid()) {
  console.log(postcode);         // M1 1AA
  console.log(postcode.outward); // M1
  console.log(postcode.inward);  // 1AA
}

Licensing

Copyright 2013 Lovell Fuller

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.