chinese-postcode
TypeScript icon, indicating that this package has built-in type declarations

1.2.0 • Public • Published

Chinese Postcode Library

CI Build

In Chinese postal system, a postcode is identified by three levels: province, city and county. This package allows you to search search the postcode by the given address identified by those three parameters. It also provides the functionality to search address from a given postcode.

Install

To get started, simply install it with npm:

npm install chinese-postcode

Usage

var pc = require('chinese-postcode');

// search addresses by postcode
var addresses = pc.getAddress('100093');

// search postcode by address
var postcode = pc.getPostcode({
    province: '湖南',
    city: '怀化市',
    county: '靖州苗族侗族自治县'
});

Contribution

Clone the repo:

git clone https://github.com/xtu/chinese-postcode.git

Run tests:

npm test

Create branch. Make changes. Push branch and create a pull request.

License

ISC

Readme

Keywords

Package Sidebar

Install

npm i chinese-postcode

Weekly Downloads

8

Version

1.2.0

License

ISC

Unpacked Size

410 kB

Total Files

10

Last publish

Collaborators

  • al2ping