https://github.com/im-parsa/iran-info
Get information about cities and provinces of Iran
https://github.com/im-parsa/iran-info
iran iran-cities iran-city iran-province iran-provinces
Last synced: about 2 months ago
JSON representation
Get information about cities and provinces of Iran
- Host: GitHub
- URL: https://github.com/im-parsa/iran-info
- Owner: im-parsa
- License: mit
- Created: 2021-12-23T19:18:10.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-12-24T13:48:19.000Z (over 3 years ago)
- Last Synced: 2025-03-27T16:09:27.423Z (2 months ago)
- Topics: iran, iran-cities, iran-city, iran-province, iran-provinces
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/iran-info
- Size: 348 KB
- Stars: 16
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Iran-Info
Get information about cities and provinces of Iran
## ⚙ Installation
`npm install iran-info`
## 📜 Usage
```js
const { Cities, Provinces } = require('iran-info');
// Cities
// @Get all cities of the Iran
new Cities().list();
// @Find cities with their names
new Cities().find("شیراز");
// @Search with keyword in all cities of the Iran
new Cities().search("ش");
// Provinces
// @Get all provinces of the Iran
new Provinces().list();
// @Find provinces with their names
new Provinces().find("فارس");
// @Search with keyword in all provinces of the Iran
new Provinces().search("ف");
```
## ✨ Features
- Get all cities of the Iran
- Get all provinces of the Iran
- Find cities with their names
- Find provinces with their names
- Search with keyword in all cities of the Iran
- Search with keyword in all provinces of the Iran
### 🚩 Credits
- We use [list-of-cities-in-Iran](https://github.com/sajaddp/list-of-cities-in-Iran) for our data.
### [MIT License](https://github.com/im-parsa/iran-info/blob/main/LICENSE)