ShahinSorkh / IRAN-locations

IRAN provinces, cities and areas

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

IRAN-locations

IRAN provinces, cities and areas

Usage

You shouldn't need to install this package as you can get the dataset directly form github. Though you can install as an npm package with the following:

$ npm i iran-locations

And use the dataset like:

const { provinces } = require('iran-locations')

console.log(provinces)
/*
   [
       {
            id: 'AZE',
            name: 'آذربايجان شرقي',
            cities: [
                {
                    id: '4',
                    name: 'تبریز',
                    areas: [
                        {
                            id: '1',
                            name: 'آزمايش'
                        },
                        ...
                    ]
                },
                ...
            ]
       },
       ...
   ]
 */

TODO

  • merge some cities to one city and many areas
  • add release actions
  • convert numeric ids to actual numbers

About

IRAN provinces, cities and areas

License:MIT License


Languages

Language:JavaScript 100.0%