https://github.com/mohammad-hassani/iran-city
a package for all cities in iran
https://github.com/mohammad-hassani/iran-city
city iran iran-city javascript package
Last synced: 7 months ago
JSON representation
a package for all cities in iran
- Host: GitHub
- URL: https://github.com/mohammad-hassani/iran-city
- Owner: mohammad-hassani
- Created: 2022-07-05T15:44:15.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-09-28T10:08:53.000Z (about 2 years ago)
- Last Synced: 2024-10-12T09:47:49.690Z (about 1 year ago)
- Topics: city, iran, iran-city, javascript, package
- Language: TypeScript
- Homepage: http://hasani.id.ir/iran-city/
- Size: 97.7 KB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# iran-city
## iran-city is a package for list of cities in iran
The 'iran-city' package can be installed using npm with the following command:
```bash
npm install iran-city
```
Here are some examples of how to use the package:
1. Get all cities in Iran:
```javascript
let iranCity = require('iran-city');
let AllCities = iranCity.allCities();
console.log(AllCities);
```
2. Get all provinces in Iran:
```javascript
let iranCity = require('iran-city');
let AllProvinces = iranCity.allProvinces();
console.log(AllProvinces);
```
3. Get cities of a specific province (e.g., province ID 20):
```javascript
let iranCity = require('iran-city');
let CitiesOfProvince = iranCity.citiesOfProvince(20);
console.log(CitiesOfProvince);
```
4. Search for cities by name (e.g., search for "کرمان"):
```javascript
let iranCity = require('iran-city');
let SearchByName = iranCity.searchByName('کرمان');
console.log(SearchByName);
```
5. Get city information by name (e.g., get information about "رفسنجان"):
```javascript
let iranCity = require('iran-city');
let CityByName = iranCity.cityByName('رفسنجان');
console.log(CityByName);
```
6. Get city information by ID (e.g., get information about city ID 766):
```javascript
let iranCity = require('iran-city');
let CityById = iranCity.cityById(766);
console.log(CityById);
```
7. Get city information by slug (e.g., get information about city slug 'رفسنجان'):
```javascript
let iranCity = require('iran-city');
let CityBySlug = iranCity.CityBySlug('رفسنجان');
console.log(CityBySlug);
```
8. Search for cities by slug (e.g., search for "کرمان"):
```javascript
let iranCity = require('iran-city');
let PCitiesBySlug = iranCity.PCitiesBySlug('کرمان');
console.log(PCitiesBySlug);
```
**Sources:**
* [iran-city package on github](https://github.com/mohammad-hassani/iran-city)
## npmjs link: [iran-city - npm](https://www.npmjs.com/package/iran-city)
* Thanks to [@sajaddp](https://github.com/sajaddp) for the help
* made with ❤ by [Mohammad Hassani](https://hasani.id.ir)