npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

postcode-format

v1.0.0

Published

JavaScript library to validate and format postcodes

Downloads

68

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

matthewkilpatrickmatthewkilpatrick

Keywords

Readme

postcode-format

A JavaScript port of the brick/postcode PHP library for validating and formatting postcodes for all countries which have a postcode system.

Installation

npm install postcode-format

Usage

import postcodeFormat from 'postcode-format';
postcodeFormat('GB', 'SW1A2aa');  // SW1A 2AA

The first argument is the ISO 3166 country code for the country which you wish to validate/format a postcode for, and the second argument is the postcode itself.

An UnknownCountryException will be thrown for invalid/unsupported countries, and an InvalidPostcodeException exception will be thrown if the provided postcode is not valid in the chosen country.

Code generation

To save development effort, some scripts (located in scripts/) have been created to parse the source code and tests from the PHP library implementation and convert these to JavaScript, so that changes made in the PHP library can be quickly ported over. In some cases, manual code changes may be required to import more complex logic.