iran-province-city-package

iran province and city package

⭐ Don't forget to give this package a star on GitHub if package was useful for you ⭐

GITHUB : https://github.com/rezafaghih/Cities_of_a_province

a simple javascript library (Package) to get Iran province and cities of a province

you can use this library in your project to get cities and province of iran

🛠️ Installation Steps:

1. Installation

npm i iran-province-city-package -- save

How to use it? 💻

for using this library in your project you need to create province class object

simply you can add script in head of your project or use module

Use Script

<script src = "node_modules/iran-province-city-package/apps.js"></script>

or use Module

    require ("iran-province-city-package");

    var province_lib = new province (); 

    // you can call any methods you like

there is few methods you can call them and use them in your project

Get Iran Province List As Json Object

if you want to get iran province list as json Object you can use this method

    province_lib.getIranProvinceList(); // simply this method will return a json 

Get Cities Of a Province

if you know Id of a province and you want to get cities of that province you can use this method

    province_lib.getProvinceCityList(cityID); // simply this method will return a json 

Get Count of province cities

get count of province cities you can use this method

    province_lib.getCountOfProvinceCities(cityID); // simply this method will integer

Get ProvinceID From Name

this method will return the provinceID from province name

    province_lib.findProvinceIdFromName (name); // simply this method will ID of province
    // name should be string
    // name can be persian like (فارس , تهران , بوشهر)
    // name can be english like (Tehran, Bushehr, Fars)

• [ ] Add Province Dropdown menu
• [ ] Add Search for Dropdown