@ac-dev/states-service 中文文档教程

Question

# State Service [](https://nodei.co/npm/@ac-dev/states-service/)
[](https://www.npmjs.com/package/@ac-dev/states-service)

Table of contents

1. Mission
2. Getting started

• Installation
• Import

1. Usage
2. Contributors
3. Need help
4. Licence
5. 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

要开始使用这个库，您需要安装它并将其添加到您的项目中。

Installation

状态服务可作为 npm 包使用。

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

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

Import

导入单个命名导入如下：

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

Usage

下面的代码片段显示了如何在一些常见用例中将 states-service 付诸行动。

• 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

任何贡献表示赞赏。 您可以从以下步骤开始：

1. 分叉此存储库（了解如何操作此处）。

2. 克隆分叉的存储库。

3. 进行更改并创建拉取请求（学习如何做到这一点)。

4. 我会处理您的拉取请求并提供一些反馈。

Need help?

Ping 我 在 Twitter 上

License

此存储库根据 MIT 许可证获得许可。

Sponsor

不要害羞！ ？？？

:heart: 赞助商