@fragaria/address-formatter

中文文档
7.1.2发布于 2026/10/01MITTypeScriptESM + CJS构建来源已验证近 30 天下载 59.6万

通用国际地址格式化 Javascript

中文使用文档
文档目录5 节
  1. 安装和使用
  2. 节点
  3. 网页直接使用
  4. 开发和测试
  5. 释放

联合来文地址

Coverage Status

基于一个惊人的作品 OpenCage 数据 这是Javascript的应用 这件事情.

这个库几乎可以格式化来自 开放街道地图 诺米纳蒂姆 API 输入 address 字段。 其他相容数据来源 例如 光子 可能也会被使用.

它能自动检测到这个国家 格式化自定义,但允许您使用 选择特定的国家 格式此外,它允许你 缩写常见的名字, 例如 Avenue 或者说 Road。 。 。 .

全世界的格式规格是 目前没有计划准备 面积有限的小型建筑.

安装和使用

节点

npm i @fragaria/address-formatter
// import addressFormatter from '@fragaria/address-formatter';
const addressFormatter = require('@fragaria/address-formatter');

// Basic examples
const formatted = addressFormatter.format({
  "houseNumber": 301,
  "road": "Hamilton Avenue",
  "neighbourhood": "Crescent Park",
  "city": "Palo Alto",
  "postcode": 94303,
  "county": "Santa Clara County",
  "state": "California",
  "country": "United States of America",
  "countryCode": "US",
});
/*
301 Hamilton Avenue
Palo Alto, CA 94303
United States of America
*/
const formattedWithAppendedCountry = addressFormatter.format({
  "houseNumber": 301,
  "road": "Hamilton Avenue",
  "neighbourhood": "Crescent Park",
  "city": "Palo Alto",
  "postcode": 94303,
  "county": "Santa Clara County",
  "state": "California",
  "countryCode": "US",
}, {
  appendCountry: true
});
/*
301 Hamilton Avenue
Palo Alto, CA 94303
United States of America
*/

// You can overwrite the country code incoming from the map service
const abbreviatedUkFormat = addressFormatter.format({
  "houseNumber": 301,
  "road": "Hamilton Avenue",
  "neighbourhood": "Crescent Park",
  "city": "Palo Alto",
  "postcode": 94303,
  "county": "Santa Clara County",
  "state": "California",
  "country": "United States of America",
  "countryCode": "US",
}, {
  abbreviate: true,
  countryCode: 'UK'
});
/*
301 Hamilton Ave
Palo Alto
94303
USA
*/

// You can use a fallback to keep the library working when the country code is wrong
const fallbackCountryCode = addressFormatter.format({
  "houseNumber": 301,
  "road": "Hamilton Avenue",
  "neighbourhood": "Crescent Park",
  "city": "Palo Alto",
  "postcode": 94303,
  "county": "Santa Clara County",
  "state": "California",
  "country": "United States of America",
  "countryCode": "yu",
}, {
  abbreviate: true,
  fallbackCountryCode: 'UK'
});
/*
301 Hamilton Ave
Palo Alto
94303
USA
*/

// You can get the address as a list of lines to make your formatting easier
const formattedAsLines = addressFormatter.format({
  "houseNumber": 301,
  "road": "Hamilton Avenue",
  "neighbourhood": "Crescent Park",
  "city": "Palo Alto",
  "postcode": 94303,
  "county": "Santa Clara County",
  "state": "California",
  "country": "United States of America",
  "countryCode": "US",
}, {
  output: 'array'
});
/*
[
  '301 Hamilton Avenue',
  'Palo Alto, CA 94303',
  'United States of America'
]
*/

网页直接使用

<script type="text/javascript" src="https://unpkg.com/@fragaria/address-formatter@latest"></script>
<script type="text/javascript">
  const formatted = window.addressFormatter.format({
    "houseNumber": 301,
    "road": "Hamilton Avenue",
    "neighbourhood": "Crescent Park",
    "city": "Palo Alto",
    "postcode": 94303,
    "county": "Santa Clara County",
    "state": "California",
    "country": "United States of America",
    "countryCode": "US",
  });
  /*
  301 Hamilton Avenue
  Palo Alto, CA 94303
  United States of America
  */
</script>

开发和测试

$ git clone [email protected]:fragaria/address-formatter.git
$ cd address-formatter
# Install the proper NodeJS
$ nvm install
# Download the /OpenCageData/address-formatting/ spec
$ npm run pull-submodules
# Install dependencies
$ npm install
# Generate JS-friendly spec
$ npm run prepare-templates
# Run the tests
$ npm test

释放

$ npm version X.Y.Z
$ git push origin master && git push origin vX.Y.Z

而CI服务器负责其他的

需要帮助

所有拉动请求都是绝对欢迎的. 如果有一个地址 格式化不良,直接向 原始仓库 最小本地化测试箱.

承认

得益于这些执行

版本与发布记录

@fragaria/address-formatter 共发布 45 个版本,首次发布于 2019/02/18;过去 12 个月发布了 3 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
7.1.2latest2026/10/011 个月前
7.1.12026/09/201 个月前
7.0.02026/05/086 个月前
6.7.12025/10/181.1 年前
6.7.02025/10/181.1 年前
6.6.52025/10/181.1 年前

关于 @fragaria/address-formatter 的常见问题

@fragaria/address-formatter 是什么?

通用国际地址格式化 Javascript

如何安装 @fragaria/address-formatter?

在项目目录运行 npm install @fragaria/address-formatter,或使用 pnpm add / yarn add / bun add。

@fragaria/address-formatter 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@fragaria/address-formatter 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@fragaria/address-formatter 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@fragaria/address-formatter 可以商用吗?

@fragaria/address-formatter 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@fragaria/address-formatter 的下载量有多少?

根据 npm 官方下载统计,@fragaria/address-formatter 在 2026/10/16 – 2026/11/14 这 30 天内被下载 595,902 次,日均约 19,863 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@fragaria/address-formatter 还在维护吗?

最新版本 7.1.2 发布于 2026/10/01(1 个月前);至今共发布 45 个版本,其中过去 12 个月发布了 3 个;首次发布于 2019/02/18。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。