ip2region

To use this library in your Node.js project, install the ip2region package using npm.

$ npm install ip2region --save

You can initialize the IP2Region instance with a configuration object to specify custom database paths or disable IPv6 support to reduce memory usage.

Available configuration keys:

• ipv4db: Path to the IPv4 database file.
• ipv6db: Path to the IPv6 database file.
• disableIpv6: Boolean flag to disable IPv6 lookup functionality.

import IP2Region from "ip2region";

const query = new IP2Region({
  ipv4db: "/tmp/db4.db",
  ipv6db: "/tmp/db6.db",
  disableIpv6: true,
});

Use the IP2Region class to perform IP-to-region lookups for both IPv4 and IPv6 addresses. The search method returns an object containing the country, province, city, and isp.

import IP2Region from "ip2region";
const query = new IP2Region();

// IPv4 lookup
const res = query.search('120.24.78.68');
console.log(res);
// Output: { country: '中国', province: '广东省', city: '深圳市', isp: '阿里云' }

// IPv6 lookup
const res2 = query.search('240e:47d:c20:1627:30a3:ba0d:a5e6:ec19');
console.log(res2);
// Output: { country: "中国", province: "广东省", city: "", isp: "中国电信" }

When instantiating Ipv4ToRegion, you can pass an optional dbPath string to the constructor.

• If an absolute path is provided, it is used directly.
• If a relative path is provided, it is resolved relative to the directory of the ipv4.ts file.
• If no path is provided, it defaults to ../../data/ip2region.db.

If the file does not exist at the resolved path, the constructor will throw an error: [Ipv4ToRegion] db file not exists : <path>.

// Using an absolute path
const locator = new Ipv4ToRegion('/absolute/path/to/ip2region.db');

// Using a relative path
const locator = new Ipv4ToRegion('./data/ip2region.db');

When instantiating the IP2Region class, you can provide an IP2RegionOpts object to specify the paths to your IPv4 and IPv6 database files. You can also choose to disable IPv6 support to save resources.

Available options:

• ipv4db (string): Path to the IPv4 database file.
• ipv6db (string): Path to the IPv6 database file.
• disableIpv6 (boolean): If set to true, the IPv6 engine will not be initialized.

import IP2Region from 'node-ip2region';

const ip2region = new IP2Region({
  ipv4db: './path/to/IPv4.mmdb',
  ipv6db: './path/to/IPv6.mmdb',
  disableIpv6: false
});

To enable the Ipv6ToRegion class to handle IPv4-mapped addresses, 6to4, Teredo, or ISATAP addresses by falling back to an IPv4 database, use the setIpv4Ins method to inject an Ipv4ToRegion instance.

const ipv6Lookup = new Ipv6ToRegion('../../data/ipv6wry.db');
const ipv4Lookup = new Ipv4ToRegion('../../data/ipv4wry.db');

// Link the IPv4 provider to the IPv6 lookup engine
ipv6Lookup.setIpv4Ins(ipv4Lookup);

The search method performs the lookup. It accepts an IPv4 string and an optional parse boolean.

Signatures:

• search(ipaddr: string): Ipv4ToRegionResult (when parse is true or omitted)
• search(ipaddr: string, parse: boolean): Ipv4ToRegionRes | null (when parse is false)

Return Types:

Ipv4ToRegionResult (Parsed):

• id: number (City ID)
• country: string
• region: string
• province: string
• city: string
• isp: string

Ipv4ToRegionRes (Raw):

• city: number
• region: string (A pipe-delimited string: country|region|province|city|isp)

If the IP address is invalid or not found in the database, the method returns null.

The search() method returns an object conforming to the IP2RegionResult interface, which provides the following geographic fields:

• country: The country name.
• province: The province or state name.
• city: The city name.
• isp: The Internet Service Provider name.

interface IP2RegionResult {
  country: string;
  province: string;
  city: string;
  isp: string;
}

When calling search(ipaddr, false), the method returns the raw database response conforming to the Ipv6ToRegionRes interface.

export interface Ipv6ToRegionRes {
  /** 区域字符串 */
  cArea: string;
  /** 运营商 */
  aArea: string;
}