Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

ipdb

metowolf1.2kMIT0.3.3

IP lookup using IPIP.net database

ipip, location, geolocation, geo, ipdb, datx, geoip

readme

ipdb Build Status

IP lookup using IPIP.net database

Free databases available for download here. If you need better accuracy you should consider buying commercial subscription.

Install

$ npm install ipdb

Usage

const IPDB = require('ipdb');
const ipdb = new IPDB('./data/ipipfree.ipdb');

ipdb.find('183.62.57.1');
/*
{
  code: 0,
  data: {
    country_name: '中国',
    region_name: '广东',
    city_name: '广州',
    bitmask: 18,
    ip: '183.62.57.1'
  }
}
*/

API

ipdb = new IPDB(file, [options])

file

Type: string | Buffer

The ipdb database pathname (string) or contents (buffer).

options

Type: object

patches

Type: array Default: []

See Patches

ipdb.find(ip, [options])

Return a result object

ip

Type: string

options

Type: object

language

Type: string Default: CN

patches

Type: array Default: []

See Patches

Patches

  • @ipdb/iso3166 - IPIP.net database patches (ISO-3166)
  • @ipdb/cac - IPIP.net database patches (中国行政区划代码)
  • @ipdb/range - IPIP.net database patches (range of cidr)

License

MIT © metowolf