https://github.com/lovell/uk-postcode

Node.js module for parsing and validating UK postcodes
https://github.com/lovell/uk-postcode

javascript nodejs postcode uk-postcode validation

Last synced: 2 months ago
JSON representation

Node.js module for parsing and validating UK postcodes

• Host: GitHub
• URL: https://github.com/lovell/uk-postcode
• Owner: lovell
• Created: 2010-09-02T19:39:42.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2013-10-28T11:21:52.000Z (about 11 years ago)
• Last Synced: 2024-10-10T00:12:23.365Z (3 months ago)
• Topics: javascript, nodejs, postcode, uk-postcode, validation
• Language: JavaScript
• Homepage:
• Size: 97.7 KB
• Stars: 11
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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

    }

## Testing [![Build Status](https://travis-ci.org/lovell/uk-postcode.png?branch=master)](https://travis-ci.org/lovell/uk-postcode)

Run the unit tests with:

    npm test

## Licence

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 [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0.html)

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.