# chinese-address-generator

**Repository Path**: jin-xuening/chinese-address-generator

## Basic Information

- **Project Name**: chinese-address-generator
- **Description**: 中国地址生成器 - 三级地址 四级地址 随机生成完整地址
- **Primary Language**: NodeJS
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 2
- **Created**: 2021-10-25
- **Last Updated**: 2023-10-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# chinese-address-generator
中国地址生成器 - 三级地址 四级地址 随机生成完整地址

## 数据
数据在`data`文件夹中, 可以自己实现想要的相关逻辑

## 用法

使用`NodeJS`
### 安装依赖
```bash
$ npm install chinese-address-generator
```

### 生成一级地址
```javascript
const generator = require('chinese-address-generator');
generator.generateLevel1(); // => {region: "上海", code: "310000"}
```

### 生成二级地址
```javascript
const generator = require('chinese-address-generator');
generator.generateLevel2(); // => {region: "上海市市辖区", code: "310100"}
```

### 生成三级地址
```javascript
const generator = require('chinese-address-generator');
generator.generateLevel3(); // => {region: "上海市市辖区浦东新区", code: "310115"}
```

### 生成四级地址
```javascript
const generator = require('chinese-address-generator/generator4');
generator.generateLevel4(); // => {region: "上海市市辖区浦东新区东海农场", code: "310115402000"}
```

### 生成完整地址
**注意: 该地址是瞎编的。按照这个地址去找不能保证绝对有**
```javascript
const generator = require('chinese-address-generator/generator4');
generator.fabricateFullAddress(); // => {region: "上海市市辖区浦东新区外高桥保税区005号606室", code: "310115501000"}
```

*P.S.: 生成规则:(001-1400)号(101-909)室*

## 关于贡献
基于MIT开源协议

欢迎pr其他语言的相关实现