• Stars
    star
    120
  • Rank 295,983 (Top 6 %)
  • Language
    JavaScript
  • Created almost 10 years ago
  • Updated about 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

The NodeJS implementation for looking up Chinese administrative divisions.

GB/T 2260

GB/T 2260 Build Status Coverage Current Release

The latest GB/T 2260 codes. Read the GB2260 Specification.

Installation

Install with npm:

$ npm install gb2260 --save

Usage

var gb2260 = require('gb2260');
// register revision data
gb2260.register('201410', require('gb2260/lib/201410'))

GB2260

var gb = new gb2260.GB2260(revision);

Interface for GB2260.

.get(code)

Get division for the given code.

var division = gb.get("110105")
// <GB/T 2260-201410> 110105 北京市 市辖区 朝阳区

division.name
// 朝阳区
division.code
// 110105
division.revision
// 201410

division.province
// <GB/T 2260-201410> 110000 北京市
division.prefecture
// <GB/T 2260-201410> 110100 市辖区

division.toJSON()
// { name: '朝阳区', code: '110105', revision: 201410 }
division.toString()
// 北京市 市辖区 朝阳区
division.valueOf()
// 北京市 市辖区 朝阳区

.provinces()

Return a list of provinces in Division data structure.

gb.provinces()

.prefectures(code)

Return a list of prefecture level cities in Division data structure.

gb.prefectures(110000)

.counties(code)

Return a list of counties in Division data structure.

gb.counties(110100)

revisions()

Return a list of available revisions.

gb2260.revisions()
// [ '201410', '201308', ..., '200212']

License

MIT.