Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/javanshen/china-region-data
中国省市区数据集合
https://github.com/javanshen/china-region-data
china collection regions
Last synced: 1 day ago
JSON representation
中国省市区数据集合
- Host: GitHub
- URL: https://github.com/javanshen/china-region-data
- Owner: JavanShen
- Created: 2022-09-28T10:59:06.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-12-22T09:12:28.000Z (24 days ago)
- Last Synced: 2024-12-22T10:22:50.397Z (24 days ago)
- Topics: china, collection, regions
- Language: TypeScript
- Homepage:
- Size: 227 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## 中国省市区数据
[](https://github.com/JavanShen/china-region-data/actions/workflows/ci.yml) [](https://codecov.io/github/JavanShen/china-region-data) [](https://www.npmjs.com/package/china-region-data)
### 特性
+ 省市区关联数据
+ 支持TS类型提示
+ 通过数据关联测试
### 安装
```shell
npm i china-region-data
```
### 使用方式
```TypeScript
import { province, city, county } from 'china-region-data'
//do something
```
### 数据格式
[省份数据](https://raw.githubusercontent.com/JavanShen/china-region-data/master/src/data/province.json)
```js
const province = [
{
//省份名称
name: '浙江省',
//行政区划代码
id: '330000000000'
},
//...
]
```
[市级数据](https://raw.githubusercontent.com/JavanShen/china-region-data/master/src/data/city.json)
```js
const city = {
//省行政区划代码
'330000000000': [
{
//上级省份
province: '浙江省',
//市级名称
name: '湖州市',
//行政区划代码
id: '330500000000'
},
//...
],
//...
}
```
[地区数据](https://raw.githubusercontent.com/JavanShen/china-region-data/master/src/data/county.json)
```js
const country = {
//市行政区划代码
'330500000000': [
{
//上级市级
city: '湖州市',
//地区名称
name: '德清县',
//行政区划代码
id: '330521000000'
}
//...
],
//...
}
```