Table of contents

1. Mission
2. Getting started
- Installation
- Import
3. Usage
4. Contributors
5. Need help
6. Licence
7. Sponsor

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.

$3

Cities Service is available as an npm package.

``bash


npm

`typescript
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.

`typescript
const cities = Cities.getCities()
`

- Get all cities by asc sort.

`typescript
const cities = Cities.getCities({
sort: {
mode: 'asc',
},
})
`

- Get all cities by desc sort.

`typescript
const cities = Cities.getCities({
sort: {
mode: 'desc',
},
})
`

- Get all cities by alphabetical sort.

`typescript
const cities = Cities.getCities({
sort: {
mode: 'alphabetical',
key: 'name',
},
})
`

- Get Italian cities.

`typescript
const cities = Cities.getCities({
filters: {
country_code: 'IT',
},
})
`

- Get Italian and French cities.

`typescript
const cities = Cities.getCities({
filters: {
country_code: ['IT', 'FR'],
},
})
`

- Get Italian Ligurian cities.

`typescript
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:

1. Fork this repository (learn how to do this here).

2. Clone the forked repository.

3. Make your changes and create a pull request (learn how to do this).

4. 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! 😜

:heart: Sponsor