Installations

npm install mmdb-lib

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=10

Node Version

20.13.1

NPM Version

10.8.0 Score

99.2

Supply Chain

93.3

Quality

76.8

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

207

Closed

2

Merged

205

Issues

Open

0

Total

5

Closed

5

Releases

11

v2.1.1

Published on 29 May 2024

v2.1.0

Published on 04 Dec 2023

v2.0.2

Published on 03 Feb 2022

v2.0.1

Published on 07 Jan 2022

v2.0.0

Published on 07 Jan 2022

v1.4.0

Published on 07 Jan 2022

View all 11 releases

Contributors

5

Unable to fetch Contributors

View all 5 contributors

Languages

2

TypeScript

JavaScript

TypeScript (98.6%)

JavaScript (1.4%)

Developer

runk

Download Statistics

Total Downloads

19,452,120

Last Day

10,339

Last Week

110,386

Last Month

615,136

Last Year

6,224,558

GitHub Statistics

28 Stars

270 Commits

10 Forks

5 Watching

7 Branches

5 Contributors

Bundle Size

8.60 kB

Minified

3.15 kB

Minified + Gzipped

Bundlephobia

Maintainers

1

Package Meta Information

Latest Version

2.1.1

Package Id

mmdb-lib@2.1.1

Unpacked Size

33.65 kB

Size

10.22 kB

File Count

19

NPM Version

10.8.0

Node Version

20.13.1

Publised On

29 May 2024

Total Downloads

Cumulative downloads

Total Downloads

19,452,120

Last day

-71.2%

10,339

Compared to previous day

Last week

-28%

110,386

Compared to previous week

Last month

8.2%

615,136

Compared to previous month

Last year

16.1%

6,224,558

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

11

@types/ip-address @types/mocha @types/node @types/sinon ip-address mocha prettier semantic-release sinon ts-node typescript

Versions

mmdb-lib

Javascript 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.

Installation

1npm i mmdb-lib

Usage

1import fs from 'fs';
2import * as mmdb from 'mmdb-lib';
3
4// Get a buffer with mmdb database, from file system or whereever.
5const db = fs.readFileSync('/path/to/GeoLite2-City.mmdb');
6
7const reader = new mmdb.Reader<CityResponse>(db);
8console.log(reader.get('66.6.44.4')); // inferred type `CityResponse`
9console.log(reader.getWithPrefixLength('66.6.44.4')); // tuple with inferred type `[CityResponse|null, number]`

Supported response types:

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

Usage in browser-like environments

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.

Options

Reader(db:Buffer, [options])

options: <Object>
- cache: <Object> Cache helper. tiny-lru is great basic option. Only two methods expected: get(key: string | number): any and set(key: string | number, val: any): void.

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

Contributing

All contributions are welcome. Please make sure to add tests for your changes.

You need to initialise the repository with the following command:

1git submodule update --init --recursive

Then you can run tests with:

1npm test

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

5.2

/10

Last Scanned on 2024-12-16

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to mmdb-lib

Other packages similar to mmdb-lib

mmdb-lib

Installations

Developer Guide

No

CommonJS

>=10

20.13.1

10.8.0

Score

Pull Requests

0

207

2

205

Issues

0

5

5

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

runk

Download Statistics

GitHub Statistics

Bundle Size

8.60 kB

3.15 kB

Maintainers

Package Meta Information

Total Downloads

19,452,120

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

mmdb-lib

Installation

Usage

Usage in browser-like environments

Options

References

License

Contributing

10

10

10

10

10

10

0

0

0

0

0

0

0

5.2

/10