postcode-validator
TypeScript icon, indicating that this package has built-in type declarations

3.10.1 • Public • Published

postcode-validator

Commitizen friendly

Node.js module for parsing and validating postcodes. Country specific validation is supported for most countries including GB, US, Canada, Japan and many others.

Note: I haven't tested all combinations of postcodes for the extended country regular expressions. Please raise a PR with necessary test coverage for as many countries possible.

Install

npm install postcode-validator

Usage

// commonjs
const { postcodeValidator, postcodeValidatorExistsForCountry } = require('postcode-validator');
// ES6
import { postcodeValidator, postcodeValidatorExistsForCountry } from 'postcode-validator';

postcodeValidator('W85TT', 'GB'); // returns true
postcodeValidator('1234567', 'GB'); // returns false

postcodeValidatorExistsForCountry('GB'); // returns true
postcodeValidatorExistsForCountry('Moon'); // returns false

country codes: US, GB, CA, JP, INTL(International), etc

Testing

Run the unit tests with:

npm test

Conventional Commits

Commit code using below npm script or just follow conventional commits for commit messages using git commit.

npm run commit

Dependencies (0)

    Dev Dependencies (14)

    Package Sidebar

    Install

    npm i postcode-validator

    Weekly Downloads

    97,517

    Version

    3.10.1

    License

    MIT

    Unpacked Size

    41.8 kB

    Total Files

    15

    Last publish

    Collaborators

    • melwynfurtado