Table of contents
Mission
- I've never found any complete library to get all world countries, states, and cities. I want to develop the best one. Of course, contributors are welcome!!
- I took this data as a starting point.
- This package is a part of countries-states-cities-service
Getting started
To get started with this library, you need to install it and add it to your project.
Installation
Cities Service is available as an npm package.
# npm
npm install @ac-dev/cities-service
# yarn
yarn add @ac-dev/cities-service
Import
Import single named import as follow:
import { Cities } from '@ac-dev/cities-service'
Usage
The code snippet below shows how to put into action cities-service
in some common use cases.
- Get all cities.
const cities = Cities.getCities()
- Get all cities by
asc
sort.
const cities = Cities.getCities({
sort: {
mode: 'asc',
},
})
- Get all cities by
desc
sort.
const cities = Cities.getCities({
sort: {
mode: 'desc',
},
})
- Get all cities by
alphabetical
sort.
const cities = Cities.getCities({
sort: {
mode: 'alphabetical',
key: 'name',
},
})
- Get Italian cities.
const cities = Cities.getCities({
filters: {
country_code: 'IT',
},
})
- Get Italian and French cities.
const cities = Cities.getCities({
filters: {
country_code: ['IT', 'FR'],
},
})
- Get Italian Ligurian cities.
const cities = Cities.getCities({
filters: {
country_code: 'IT',
state_code: '42', // Region iso2
},
})
Contributors
Any contribution is appreciated. You can get started with the steps below:
-
Fork this repository (learn how to do this here).
-
Clone the forked repository.
-
Make your changes and create a pull request (learn how to do this).
-
I will attend to your pull request and provide some feedback.
Need help?
Ping me on Twitter
License
This repository is licensed under the MIT License.
Sponsor
Don't be shy!