Package Exports

@ac-dev/states-service
@ac-dev/states-service/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@ac-dev/states-service) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

State Service

Mission
Getting started
- Installation
- Import
Usage
Contributors
Need help
Licence
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.

Installation

Countries States Cities Service is available as an npm package.

# npm
npm install @ac-dev/states-service

# yarn
yarn add @ac-dev/states-service

Import

Import single named import as follow:

import { States } from '@ac-dev/states-service'

Usage

The code snippet below shows how to put into action states-service in some common use cases.

Get all states.

const states = States.getStates()

Get all states by asc sort.

const states = States.getStates({
  sort: {
    mode: 'asc',
  },
})

Get all states by desc sort.

const states = States.getStates({
  sort: {
    mode: 'desc',
  },
})

Get all states by alphabetical sort.

const states = States.getStates({
  sort: {
    mode: 'alphabetical',
    key: 'name',
  },
})

Get all states with localization.

const states = States.getStates({ locale: 'it' })

Get states by country code.

const states = States.getStates({ filters: { country_code: 'IT' } })

Get states by an array of country code.

const states = States.getStates({ filters: { country_code: ['IT', 'US'] } })

Get states by country code and localization (available only for Italian states for now).

const states = States.getStates({
  filters: { country_code: 'IT' },
  locale: 'it',
})

Get regions by country code (available only for Italian states for now).

const states = States.getStates({
  filters: {
    country_code: 'IT',
    is_region: true,
  },
})

Get a state by country code and state code.

const states = States.getStates({
  filters: {
    country_code: 'IT',
    state_code: 'GE',
  },
})

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.

Don't be shy! 😜

❤️ Sponsor

@ac-dev/states-service