# ip2region-js

**Repository Path**: ALI1416/ip2region-js

## Basic Information

- **Project Name**: ip2region-js
- **Description**: IP Address To Region For JavaScript IP地址转区域JavaScript版
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-08-19
- **Last Updated**: 2024-12-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# IP Address To Region For JavaScript IP地址转区域JavaScript版

[![License](https://img.shields.io/github/license/ALI1416/ip2region-js?label=License)](https://www.apache.org/licenses/LICENSE-2.0.txt)
[![Node Support](https://img.shields.io/badge/Node-14+-green)](https://nodejs.org/)
[![NPM](https://img.shields.io/npm/v/@ali1416/ip2region?label=NPM)](https://www.npmjs.com/package/@ali1416/ip2region)
[![Tag](https://img.shields.io/github/v/tag/ALI1416/ip2region-js?label=Tag)](https://github.com/ALI1416/ip2region-js/tags)
[![Repo Size](https://img.shields.io/github/repo-size/ALI1416/ip2region-js?label=Repo%20Size&color=success)](https://github.com/ALI1416/ip2region-js/archive/refs/heads/master.zip)

[![Node CI](https://github.com/ALI1416/ip2region-js/actions/workflows/ci.yml/badge.svg)](https://github.com/ALI1416/ip2region-js/actions/workflows/ci.yml)

## 简介

本项目迁移自[ALI1416/ip2region](https://github.com/ALI1416/ip2region)，构建后`ip2region.min.js`文件仅`3kb`

[在线示例](https://www.404z.cn/demo/ip2region.html)

## 数据文件

- 数据文件目录：[点击查看](https://github.com/ALI1416/ip2region/tree/master/data)

### 其他语言项目

- `Java` : [ALI1416/ip2region](https://github.com/ALI1416/ip2region)
- `.Net` : [ALI1416/Ip2Region.Net](https://github.com/ALI1416/Ip2Region.Net)

## 依赖导入

### 网页

<https://unpkg.com/@zip.js/zip.js/dist/zip.min.js>
<https://unpkg.com/@ali1416/ip2region/dist/ip2region.min.js>

### node

```sh
npm install @ali1416/ip2region
```

## 使用示例

```js
// node test-node.js
const fs = require('fs')
const {Ip2Region} = require('../dist/ip2region.node')

let url = 'https://www.404z.cn/files/ip2region/v3.0.0/data/ip2region.zdb'
let zdbPath = 'D:/ip2region.zdb'

let ip2Region = new Ip2Region()

// runUrl()
runFile()

async function runUrl() {
  await ip2Region.initByUrl(url)
  run()
}

async function runFile() {
  console.log(`是否已经初始化：${ip2Region.initialized()}`)
  let buffer = fs.readFileSync(zdbPath).buffer
  await ip2Region.init(buffer)
  console.log(`是否已经初始化：${ip2Region.initialized()}`)
  run()
}

function run() {
  console.log(ip2Region.parse('0.0.0.0'))
  console.log(ip2Region.parse('123.132.0.0'))
  console.log(`ip2Number 123.132.0.0 -> ${ip2Region.ip2Number('123.132.0.0')}`)
  console.log(`number2Ip 2072248320 -> ${ip2Region.number2Ip('2072248320')}`)
  console.log(`123.132.0.0 是合法的IP地址 -> ${ip2Region.isValidIp('123.132.0.0')}`)
}
```

更多请见[测试](./test)

## 更新日志

[点击查看](./CHANGELOG.md)

## 参考

- [ALI1416/ip2region](https://github.com/ALI1416/ip2region)

## 关于

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://www.404z.cn/images/about.dark.svg">
  <img alt="About" src="https://www.404z.cn/images/about.light.svg">
</picture>