Maxmind DB (MMDB) Library
npm install mmdb-libJavascript library for working with Maxmind binary databases (aka mmdb or geoip2).
Library is designed to be agnostic to environment and works equally well in node.js and browser. Module is fully compatible with IPv6. There are no differences in API between IPv4 and IPv6.
``shell`
npm i mmdb-lib
`typescript
import fs from 'fs';
import * as mmdb from 'mmdb-lib';
// Get a buffer with mmdb database, from file system or whereever.
const db = fs.readFileSync('/path/to/GeoLite2-City.mmdb');
const reader = new mmdb.Reader
console.log(reader.get('66.6.44.4')); // inferred type CityResponse
console.log(reader.getWithPrefixLength('66.6.44.4')); // tuple with inferred type
Supported response types:
`
- CountryResponse
- CityResponse
- AnonymousIPResponse
- AnonymousPlusResponse
- AsnResponse
- ConnectionTypeResponse
- DomainResponse
- IspResponse
Library expects to receive an instance of Buffer during instantiation of Reader. Since there is no direct alternative of node's Buffer in browser, you can use https://github.com/feross/buffer that mimics native Buffer interface. Neither ArrayBuffer nor Uint8Array is supported right now. Another requirement is BigInt object available.
_Reader(db:Buffer, [options])_
- options:
- 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/
MIT
All contributions are welcome. Please make sure to add tests for your changes.
You need to initialise the repository with the following command:
`shell`
git submodule update --init --recursive
Then you can run tests with:
`shell``
npm test