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

发布于 3年前 浏览 19 项目主页 更新于 3年前

# Countries Service [![NPM](https://nodei.co/npm/@ac-dev/countries-service.png?compact=true)](https://nodei.co/npm/@ac-dev/countries-service/)
[![](https://img.shields.io/npm/dt/@ac-dev/countries-service.svg?style=flat-square)](https://www.npmjs.com/package/@ac-dev/countries-service)

Table of contents

  1. Mission
  2. Getting started
  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

Countries States Cities Service 作为 npm 包提供。

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

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

Import

导入单个命名导入如下:

import { Countries } from '@ac-dev/countries-service'

Usage

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

  • Get all countries.
const countries = Countries.getCountries()
  • Get all countries by asc sort.
const countries = Countries.getCountries({
  sort: {
    mode: 'asc',
  },
})
  • Get all countries by desc sort.
const countries = Countries.getCountries({
  sort: {
    mode: 'desc',
  },
})
  • Get all countries by alphabetical sort.
const countries = Countries.getCountries({
  sort: {
    mode: 'alphabetical',
    key: 'iso2',
  },
})
  • Get all countries with localization.
const countries = Countries.getCountries({ locale: 'it' })
  • Get a country by iso2 code.
const countries = Countries.getCountries({ filters: { iso2: 'US' } })
  • Get a country by iso2 code and localization.
const countries = Countries.getCountries({
  filters: { iso2: 'IT' },
  locale: 'it',
})
  • Get a country by iso3 code.
const countries = Countries.getCountries({ filters: { iso3: 'ITA' } })

Contributors

任何贡献表示赞赏。 您可以通过以下步骤开始:创建

  1. 此存储库(了解如何执行此操作 此处)。

  2. 克隆分叉的存储库。

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

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

Need help?

Ping 我 在 Twitter 上

License

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

不要害羞! ???

:heart: 赞助商

# Countries Service [![NPM](https://nodei.co/npm/@ac-dev/countries-service.png?compact=true)](https://nodei.co/npm/@ac-dev/countries-service/)
[![](https://img.shields.io/npm/dt/@ac-dev/countries-service.svg?style=flat-square)](https://www.npmjs.com/package/@ac-dev/countries-service)

Table of contents

  1. Mission
  2. Getting started
  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

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/countries-service

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

Import

Import single named import as follow:

import { Countries } from '@ac-dev/countries-service'

Usage

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

  • Get all countries.
const countries = Countries.getCountries()
  • Get all countries by asc sort.
const countries = Countries.getCountries({
  sort: {
    mode: 'asc',
  },
})
  • Get all countries by desc sort.
const countries = Countries.getCountries({
  sort: {
    mode: 'desc',
  },
})
  • Get all countries by alphabetical sort.
const countries = Countries.getCountries({
  sort: {
    mode: 'alphabetical',
    key: 'iso2',
  },
})
  • Get all countries with localization.
const countries = Countries.getCountries({ locale: 'it' })
  • Get a country by iso2 code.
const countries = Countries.getCountries({ filters: { iso2: 'US' } })
  • Get a country by iso2 code and localization.
const countries = Countries.getCountries({
  filters: { iso2: 'IT' },
  locale: 'it',
})
  • Get a country by iso3 code.
const countries = Countries.getCountries({ filters: { iso3: 'ITA' } })

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.

Don't be shy! ????

:heart: Sponsor

    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文