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

uk-postcodes-node

v0.2.3

Published

Wrapper for UK-Postcodes.com API

Downloads

12

Readme

UK-Postcodes Node.js Wrapper

This is a API wrapper for uk-postcodes.com, a free lookup API for UK postcodes

Installation

npm install uk-postcodes

Getting Started

Looking up a postcode

var postcode = "SW1A 2AA";

UKPostcodes.getPostcode(postcode, function (error, data) {
	console.log(data);
	// {
	//   "postcode": "SW1A 2AA",
	//   "geo": {
	//     "lat": 51.503539898875815,
	//     "lng": -0.12768084037293415,
	//     "easting": 530047,
	//     "northing": 179951,
	//     "geohash": "http://geohash.org/gcpuvpgjbgdq"
	//   },
	//   "administrative": {
	//     "council": {
	//       "title": "City of Westminster",
	//       "uri": "http://statistics.data.gov.uk/id/statistical-geography/E09000033",
	//       "code": "E09000033"
	//     },
	//     "ward": {
	//       "title": "St. James's",
	//       "uri": "http://statistics.data.gov.uk/id/statistical-geography/E05000644",
	//       "code": "E05000644"
	//     },
	//     "constituency": {
	//       "title": "Cities of London and Westminster",
	//       "uri": "http://statistics.data.gov.uk/id/statistical-geography/E14000639",
	//       "code": "E14000639"
	//     }
	//   }
	// }
});

Lookup nearest postcode for point

  • latlng is a string indicating a geolocation within the UK, e.g. "52.22331,-0.215323"
UKPostcodes.nearestPostcode(latlng, function (error, data) {
	// Returns postcode object as above
})

To be implemented

Looking up within X miles of postcode

UKPostcodes#nearest("postcode", [radius], callback);

Radius defaults to 10 miles

// What are the nearest postcodes within a 12 mile radius of NW1 9HZ?

UKPostcodes.nearest("NW1 9HZ", 12, function (error, postcodes) {
	
})

Looking up postcodes within X miles of point

UKPostcodes#nearest(longitude, latitude, [radius], callback);

Radius defaults to 10 miles

// What are the nearest postcodes within a 12 mile radius of 52.9667,-1.1667?

UKPostcodes.nearest("52.9667", "-1.1667", 12, function (error, postcodes) {
	
})

Test

npm test

Todo

  • Implement nearest postcodes within vicinity lookups for postcode and latlng
  • Await outcome to issue#11 to implement reponse to inappropriate latlng lookups

License

MIT