简介
common-locations
是一个npm包,它提供了一个集合,其中包括了ISO 3166-1
中的国家列表和大城市的经纬度。
安装
如果您已经安装了npm,可以直接在终端中输入以下命令进行安装:
npm install common-locations
如果您使用的是yarn,则可以用以下命令来安装
yarn add common-locations
使用
使用common-locations
实际上很简单。您只需要在您的前端代码中引入它,然后使用它提供的函数。下面是一个简单的例子:
import { countries } from 'common-locations' console.log(countries)
输出结果将会是包含所有国家信息的一个数组。
API
common-locations
包含以下几个函数:
countries
这个函数将返回ISO 3166-1中的所有国家以及它们的英文名字、两位国家代码、三位国家代码和数字代码
largeCities
这个函数将返回一组包含大城市名称、所在国家、纬度和经度的对象列表。
getLocationByCityName(cityName: string): { name, country, latitude, longitude }
这个函数将返回一个对象,包含给定城市名称、所在国家、纬度和经度。
getCountryByAlpha2Code(alpha2Code: string): { name, alpha2Code, alpha3Code, numericCode }
这个函数将返回一个包含给定alpha2Code值的国家的对象,包括国家名称、alpha2Code、alpha3Code和numericCode。
getCountryByAlpha3Code(alpha3Code: string): { name, alpha2Code, alpha3Code, numericCode }
这个函数将返回一个包含给定alpha3Code值的国家的对象,包括国家名称、alpha2Code、alpha3Code和numericCode。
getCountryByNumericCode(numericCode: number): { name, alpha2Code, alpha3Code, numericCode }
这个函数将返回一个包含给定numericCode值的国家的对象,包括国家名称、alpha2Code、alpha3Code和numericCode。
示例
import { countries, largeCities, getLocationByCityName } from 'common-locations' console.log(countries) console.log(largeCities) console.log(getLocationByCityName('New York'))
输出:
-- -------------------- ---- ------- - - ----- -------------- ----------- ----- ----------- ------ ------------ - -- - ----- ------ --------- ----------- ----- ----------- ------ ------------ --- -- - ----- ---------- ----------- ----- ----------- ------ ------------ - -- --- - - - ----- -------- -------- -------- --------- -------- ---------- -------- -- - ----- -------- -------- -------- --------- -------- ---------- ------- -- - ----- ----------- -------- -------- --------- -------- ---------- -------- -- --- - - ----- ---- ------ -------- ------- -------- --------- -------- ---------- ------- --
总结
common-locations
是一个非常实用的npm包,如果您需要在您的前端应用程序中使用国家和大城市的信息,那么这个包将会是一个好选择。通过本教程,您已经了解到如何使用这个包中的函数,同时也了解了它提供了哪些函数和数据。希望这篇文章对您有所帮助!
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005664b81e8991b448e2676