DOCSEARCHbyAlgolia
Submit Docs

province-city-china

repository·master·Indexed 25 days ago

https://github.com/uiwjs/province-city-china

A comprehensive collection of packages providing administrative division data for China, based on GB/T 2260 standards. It includes data from country and province levels down to town/street levels, featuring modular packages for provinces, cities, areas, towns, hierarchical data, and domestic long-distance telephone area codes. The library provides data in JSON and CSV formats, including compressed versions to reduce bundle size, and includes utility methods and TypeScript definitions.

Tokens
8.5K
Snippets
35
Records
70
Agent score
77%

What's inside province-city-china

  1. Overview of province-city-china packages

    master

    The province-city-china ecosystem is split into several specialized packages:

    PackageDescription
    province-city-chinaContains all package contents
    @province-city-china/countryCountry and region code list
    @province-city-china/dataTotal data (Province/City/District/Town)
    @province-city-china/provinceProvincial level (Province/Municipality/SAR)
    @province-city-china/cityPrefectural level (City)
    @province-city-china/areaCounty level (District/County)
    @province-city-china/townTownship level (Town/Street)
    @province-city-china/levelHierarchical data (Province/City/District/Town)
    @province-city-china/utilsData utility methods
    @province-city-china/typesType definitions
    @province-city-china/district-codeDomestic long-distance telephone area codes

  2. Overview of province-city-china packages

    master

    The province-city-china repository provides modular packages for Chinese administrative division data:

    PackageDescription
    province-city-chinaContains all package contents
    @province-city-china/countryCountry and region code list
    @province-city-china/dataFull dataset (Province/City/District/Town)
    @province-city-china/provinceProvincial level (Province/Municipality/SAR)
    @province-city-china/cityPrefecture level (City)
    @province-city-china/areaCounty level (District/County)
    @province-city-china/townTownship level (Town/Street)
    @province-city-china/levelHierarchical data (Province/City/District/Town)
    @province-city-china/utilsUtility methods for using the data
    @province-city-china/typesTypeScript definition files
    @province-city-china/district-codeDomestic long-distance telephone area codes

  3. Data sources and validation logic

    master

    The data in this repository is derived from several official sources and undergoes specific validation processes:

    • Primary Source: Ministry of Civil Affairs (中华人民共和国民政部) administrative division data.
    • Special Handling for Autonomous Regions/Provinces: Certain provinces (e.g., Hubei, Henan, Xinjiang, Hainan) have unique administrative structures like 'Autonomous Region Directly Managed County-level Administrative Divisions' (自治区直辖县级行政区划) or 'Province Directly Managed County-level Administrative Divisions' (省直辖县级行政区划). These are validated against National Bureau of Statistics data to ensure accuracy (e.g., ensuring missing cities like 'Xinxing City' in Xinjiang are included).
    • Municipalities: Data for Beijing, Shanghai, Tianjin, and Chongqing are specially processed during hierarchy generation because they only contain district-level data.

  4. Package overview and available modules

    master

    The province-city-china ecosystem is split into several specialized packages:

    PackageDescription
    province-city-chinaContains all package contents
    @province-city-china/countryCountry and region code list
    @province-city-china/dataFull dataset (province/city/area/town)
    @province-city-china/provinceProvincial level data (provinces/municipalities/SARs)
    @province-city-china/cityPrefectural level data (cities)
    @province-city-china/areaCounty level data (districts/counties)
    @province-city-china/townTownship level data (towns/streets)
    @province-city-china/levelHierarchical level data
    @province-city-china/utilsUtility methods for using the data
    @province-city-china/typesTypeScript type definitions
    @province-city-china/district-codeDomestic long-distance telephone area codes

  5. Package overview and scope

    master

    The province-city-china repository is modularized into several packages depending on the administrative level or utility needed:

    • province-city-china: Contains all package contents.
    • @province-city-china/country: Country and region code lists.
    • @province-city-china/data: Full dataset (Province/City/Area/Town).
    • @province-city-china/province: Province-level data (Provinces/Municipalities/SARs).
    • @province-city-china/city: City-level data.
    • @province-city-china/area: County-level data.
    • @province-city-china/town: Town-level data.
    • @province-city-china/level: Hierarchical data (Province/City/Area/Town).
    • @province-city-china/utils: Utility methods for using the data.
    • @province-city-china/types: TypeScript type definitions.
    • @province-city-china/district-code: Domestic long-distance telephone area codes.

  12. Access administrative data via CDN

    master

    You can access the administrative division data directly via CDN without installing the package. The resources are available through UNPKG, Githack, or Statically.

    Example CDN URLs:

    • https://unpkg.com/province-city-china/dist/city.json
    • https://raw.githack.com/uiwjs/province-city-china/gh-pages/city.json
    • https://cdn.statically.io/gh/uiwjs/province-city-china/gh-pages/city.json