libmaxminddb/README.md

Node.js bindings for libmaxminddb (to read MaxMind DB with the best performance - using memory-mapped file!)

# libmaxminddb

[![npm version](https://img.shields.io/npm/v/libmaxminddb.svg)](https://www.npmjs.com/package/libmaxminddb)
![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)
[![Test Status](https://img.shields.io/github/actions/workflow/status/nathan818fr/node-libmaxminddb/test.yml?branch=master)](https://github.com/nathan818fr/node-libmaxminddb/actions/workflows/test.yml)

Node.js bindings for [libmaxminddb](https://github.com/maxmind/libmaxminddb). \
To read MaxMind Databases with the best performance (using memory-mapped files)!

This module provides its own TypeScript declarations (.d.ts).

## Installation

```bash
npm install libmaxminddb
```

This package uses the native library libmaxminddb.
If you have a common system then a prebuilt version will be used.\
Otherwise look at the [advanced libmaxminddb installation instructions](https://github.com/nathan818fr/node-libmaxminddb/blob/master/docs/install_libmaxminddb.md).

## Examples

```javascript
const {MmdbReader} = require('libmaxminddb');

MmdbReader.open({filename: 'GeoIP2-Country-Test.mmdb'}).then(async (mmdb) => {
  const {netmask, entry} = await mmdb.lookup('50.114.1.1');
  console.log(entry);
});
```

For a more detailed example look at [demo.js](https://github.com/nathan818fr/node-libmaxminddb/blob/master/docs/examples/demo.js)
(or [demo.ts](https://github.com/nathan818fr/node-libmaxminddb/blob/master/docs/examples/demo.ts) for TypeScript).

## Documentation

For a detailed API reference, see:
[node-libmaxminddb.nathan818.fr](https://node-libmaxminddb.nathan818.fr/classes/MmdbReader.html#open)

## Testing

To run the test suite, you first need to clone the submodules.

```bash
git submodule init
git submodule update --recursive
```

Then install the dependencies and run `npm run test`:

```bash
npm ci
npm run test
```

## Contributing

Contributions are welcome.
It is recommended to open an issue before introducing new features to discuss them.

## Versioning

We use [SemVer](http://semver.org/) for versioning.
For the versions available, see the [tags on this repository](https://github.com/nathan818fr/node-libmaxminddb/tags).

## Authors

- [Nathan Poirier](https://github.com/nathan818fr) <nathan@poirier.io>

## License

This project is licensed under the Apache-2.0 License.
See the [LICENSE](https://github.com/nathan818fr/node-libmaxminddb/blob/master/LICENSE) file for details.