@ac-dev/states-service

State Service

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.

Installation

States 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:

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

Changelog

1.1.1 (2022-09-29)

Bug Fixes

• Typo Valle D'Aosta to Aosta Valley (b42dc75)

Bug Fixes

• Miss District of Columbia (b3edce0)

Features

• Add cjs version, lint, and new specs (3247596)