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

local-reverse-postalcode

v0.0.4

Published

Given a lat/long lookup the closest postal code

Downloads

5

Readme

Local Reverse Postal Code Geocoder

This library provides a local reverse postal code geocoder for Node.js that is based on GeoNames data. It is local in the sense that there are no calls to a remote service like the Google Maps API, and in consequence the gecoder is suitable for batch reverse geocoding. It is reverse in the sense that you give it a (list of) point(s), i.e., a latitude/longitude pair, and it returns the postal code to that point.

Installation

$ npm install local-reverse-postal code

Usage

Lookup

var geocoder = require('local-reverse-postalcode');

// With just one point
var point = {latitude: 42.083333, longitude: 3.1};
geocoder.lookUp(point, function(err, res) {
  console.log(JSON.stringify(res, null, 2));
});

// In batch mode with many points
var points = [
  {latitude: 42.083333, longitude: 3.1},
  {latitude: 48.466667, longitude: 9.133333}
];
geocoder.lookUp(points, function(err, res) {
  console.log(JSON.stringify(res, null, 2));
});


// How many results to display at max
var maxResults = 5;

// With just one point
var point = {latitude: 42.083333, longitude: 3.1};
geocoder.lookUp(point, maxResults, function(err, res) {
  console.log(JSON.stringify(res, null, 2));
});

// In batch mode with many points
var points = [
  {latitude: 42.083333, longitude: 3.1},
  {latitude: 48.466667, longitude: 9.133333}
];
geocoder.lookUp(points, maxResults, function(err, res) {
  console.log(JSON.stringify(res, null, 2));
});

Init

You can optionally initialize the geocoder prior to the first call to lookUp. This ensures that all files are loaded into the cache prior to making the first call.

var geocoder = require('local-reverse-postalcode');

geocoder.init(function() {
  // geocoder is loaded and ready to run
});

Optionally init allows you to specify the directory that geonames files are downloaded and cached in.

var geocoder = require('local-reverse-postalcode');

geocoder.init({cacheDirectory: '/tmp/geonames'}, function() {
  // Ready to call lookUp and all files will be downloaded to /tmp/geonames
});

Usage of the Web Service

You can use the built-in Web service by running node app.js as follows.

$ curl "http://localhost:3000/geocode?latitude=48.466667&longitude=9.133333"

Result Format

An output array that maps each point in the input array (or input object converted to a single-element array) to the maxResults closest postal codes.

[
   {
      "countryCode":"US",
      "postalCode":"10018",
      "placeName":"New York City",
      "adminName1":"New York",
      "adminCode1":"NY",
      "adminName2":"New York",
      "adminCode2":"061",
      "adminName3":null,
      "adminCode3":null,
      "latitude":"40.7547",
      "longitude":"-73.9925",
      "accuracy":null,
      "distance":0.01717469835623254
   },
   {
      "countryCode":"US",
      "postalCode":"10122",
      "placeName":"New York City",
      "adminName1":"New York",
      "adminCode1":"NY",
      "adminName2":"New York",
      "adminCode2":"061",
      "adminName3":null,
      "adminCode3":null,
      "latitude":"40.7518",
      "longitude":"-73.9922",
      "accuracy":null,
      "distance":0.328619663752171
   },
   {
      "countryCode":"US",
      "postalCode":"10123",
      "placeName":"New York City",
      "adminName1":"New York",
      "adminCode1":"NY",
      "adminName2":"New York",
      "adminCode2":"061",
      "adminName3":null,
      "adminCode3":null,
      "latitude":"40.7515",
      "longitude":"-73.9905",
      "accuracy":null,
      "distance":0.4042385734624632
   },
   {
      "countryCode":"US",
      "postalCode":"10120",
      "placeName":"New York City",
      "adminName1":"New York",
      "adminCode1":"NY",
      "adminName2":"New York",
      "adminCode2":"061",
      "adminName3":null,
      "adminCode3":null,
      "latitude":"40.7506",
      "longitude":"-73.9894",
      "accuracy":null,
      "distance":0.5368946061124421
   },
   {
      "countryCode":"US",
      "postalCode":"10121",
      "placeName":"New York City",
      "adminName1":"New York",
      "adminCode1":"NY",
      "adminName2":"New York",
      "adminCode2":"061",
      "adminName3":null,
      "adminCode3":null,
      "latitude":"40.7496",
      "longitude":"-73.9919",
      "accuracy":null,
      "distance":0.5745045613406756
   }
]

#A Word on Speed

The call to init takes quite a while, as the geocoder has to download roughly 9MB of data that it then caches locally (unzipped, this occupies about 76MB of disk space). All follow-up requests are lightning fast.

If you can deploy the data ahead of time the download/unzip process is eliminated but parsing and loading data structures takes a bit of time.

#License

Copyright 2015-2018 Chris Kinsman ([email protected])

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

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.

#Acknowledgements

This project was inspired by Richard Penman's Python reverse geocoder. This was a spin off of Thomas Steiner's local-reverse-geocoder. It uses Ubilabs' k-d-tree implementation that was ported to Node.js by Luke Arduini.