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

@sagi.io/maxmind

v2.11.3

Published

IP lookup using Maxmind databases

Downloads

57

Readme

This is a fork. Tailored for my own specific needs.

node-maxmind Build Status

Pure Javascript module for Geo IP lookup using Maxmind binary databases (aka mmdb or geoip2). Fastest Maxmind lookup library available - up to 17,000% faster than other libraries. Module has 100% test coverage with comprehensive test suite. It natively works with binary Maxmind database format and doesn't require any "CSV - {specific lib format}" conversions as some other modules do. Maxmind binary databases are highly optimized for size and performance so there's no point working with other than that format.

GEO databases

You might want to use geolite2 module with free geo databases. Alternatively, free databases available for download here. If you need better accuracy you should consider buying commercial subscription.

Installation

npm i maxmind

Usage

JavaScript

var maxmind = require('maxmind');

maxmind.open('/path/to/GeoLite2-City.mmdb', (err, cityLookup) => {
  var city = cityLookup.get('66.6.44.4');
});

maxmind.open('/path/to/GeoOrg.mmdb', (err, orgLookup) => {
  var city = orgLookup.get('66.6.44.4');
});

// Be careful with sync version! Since mmdb files
// are quite large (city database is about 100Mb)
// `fs.readFileSync` blocks whole process while it
// reads file into buffer.

var cityLookup = maxmind.openSync('/path/to/GeoLite2-City.mmdb');
var city = cityLookup.get('66.6.44.4');

var orgLookup = maxmind.openSync('/path/to/GeoOrg.mmdb');
var organization = orgLookup.get('66.6.44.4');

TypeScript

import * as maxmind from 'maxmind';

maxmind.open<maxmind.CityResponse>('/path/to/GeoLite2-City.mmdb', (err, cityLookup) => {
  let city = cityLookup.get('8.8.8.8'); // inferred type maxmind.CityResponse
});


// sync version

let cityLookup = maxmind.openSync<maxmind.CityResponse>('/path/to/GeoLite2-City.mmdb');
let city = cityLookup.get('8.8.8.8'); // inferred type maxmind.CityResponse


// use Reader class directly

let cityLookup: maxmind.Reader<maxmind.CityResponse> = null;
myLib.downloadFromCloudToStream(someCloudMaxmindDbUrl, (err, buffer) => {
  if (!err) {
    cityLookup = new maxmind.Reader(buffer);
  }
});

if (cityLookup) {
  let city = cityLookup.get('8.8.8.8'); // inferred type maxmind.CityResponse
}

Supported response types:

- CountryResponse
- CityResponse
- AnonymousIPResponse
- AsnResponse
- ConnectionTypeResponse
- DomainResponse
- IspResponse

V6 Support

Module is fully compatible with IPv6. There are no differences in API between IPv4 and IPv6.

var lookup = maxmind.openSync('/path/to/GeoLite2.mmdb');
var location = lookup.get('2001:4860:0:1001::3004:ef68');

Options

cache

Module uses tiny-lru. You can configure its settings by doing following:

var lookup = maxmind.openSync('/path/to/GeoLite2.mmdb', {
  cache: {
    max: 500, // Max items in cache, by default it's 6000
  }
});
lookup.get('1.1.1.1');

watchForUpdates

Supports reloading the reader when changes occur to the database that is loaded. (default false). Only supported by Node v0.5.10+.

var lookup = maxmind.openSync('/path/to/GeoLite2.mmdb', { watchForUpdates: true });
lookup.get('1.1.1.1');

You also can specify wether the watcher should be persistent or not. If it is persistent, a node process will be blocked in watching state if the watcher is the only thing still running in the program. You can use watchForUpdatesNonPersistent option (default false) to prevent this behavior.

var lookup = maxmind.openSync('/path/to/GeoLite2.mmdb', {
  watchForUpdates: true,
  watchForUpdatesNonPersistent: true,
});
lookup.get('1.1.1.1');

Also, you can specify custom hook function on database update.

var opts = {
  watchForUpdates: true,
  watchForUpdatesHook: () => { console.log('database updated!'); },
};
var lookup = maxmind.openSync('/path/to/GeoLite2.mmdb', opts);
lookup.get('1.1.1.1');

IP addresses validation

Module supports validation for both IPv4 and IPv6:

maxmind.validate('66.6.44.4'); // returns true
maxmind.validate('66.6.44.boom!'); // returns false

maxmind.validate('2001:4860:0:1001::3004:ef68'); // returns true
maxmind.validate('2001:4860:0:1001::3004:boom!'); // returns false

GeoIP Legacy binary format

In case you want to use legacy GeoIP binary databases you should use [email protected].

References

  • Loosely based on https://github.com/PaddeK/node-maxmind-db
  • MaxMind DB file format specification http://maxmind.github.io/MaxMind-DB/
  • MaxMind test/sample DB files https://github.com/maxmind/MaxMind-DB
  • GeoLite2 Free Downloadable Databases http://dev.maxmind.com/geoip/geoip2/geolite2/
  • Great talk about V8 performance https://www.youtube.com/watch?v=UJPdhx5zTaw
  • V8 Optimization killers https://github.com/petkaantonov/bluebird/wiki/Optimization-killers
  • More V8 performance tips http://www.html5rocks.com/en/tutorials/speed/v8/

License

MIT