# @foerster-technologies/phonenumbers 中文文档

规范地址：https://npmcn.com/package/%40foerster-technologies/phonenumbers/

版本：1\.0\.2
npm 元数据更新时间：2022-04-05T11:35:41.572Z
中文译文更新时间：2026-11-15T04:18:18.981Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40foerster-technologies/phonenumbers
原文对照：https://npmcn.com/package/%40foerster-technologies/phonenumbers/?lang=original
项目主页：https://github.com/foerster-technologies/phonenumbers#readme
源码仓库：https://github.com/foerster-technologies/phone

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：43.4 kB，8 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=6\.10\.0
- 运行依赖：0 个
- 首次发布：2020-08-05T11:46:12.930Z
- 最新版本发布：2020-08-05T12:23:24.155Z
- 近 30 天下载量：2328（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

使用特定国家和电话号码,验证电话号码并将其格式化为E.164标准

## 安装

```sh
npm install @foerster-technologies/phonenumbers
```

也可以使用：`pnpm add @foerster-technologies/phonenumbers`、`yarn add @foerster-technologies/phonenumbers`、`bun add @foerster-technologies/phonenumbers`

## README

# 电话 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com/)

## 电话号码是什么?

这是电话包的叉子.

`phonenumber` 用于正常移动和 **陆线电话** 数字改为E.164格式.

一个常见的问题是,用户通常以这种方式输入电话号码:

```
`(817) 569-8900` or
`817569-8900` or
`1(817) 569-8900` or
`+1(817) 569-8900` or ...
```

我们总是希望:

```
+18175698900
```

## 安装

```
npm install phone
```

或者说

```
yarn add phone
```

## 演示

从 `phone` [在密码箱里试试看](https://codesandbox.io/s/phone-browser-example-react-o5vt5?file=/src/App.js)

## 使用量

```javascript
const phone = require('phonenumbers');

phone('+852 6569-8900'); // return ['+85265698900', 'HKG']
phone('+1(817) 569-8900', ''); // return ['+18175698900', 'USA']
phone('(817) 569-8900', 'USA'); // return ['+18175698900', 'USA']
phone('(817) 569-8900', 'HKG'); // return []
phone('+1(817) 569-8900', 'HKG'); // return [], as it is not a valid HKG mobile phone number
phone('6123-6123', 'HKG'); // return ['+85261236123', 'HKG']
```

如果不提供国家代码和国家电话前缀,默认将被视为美国或加拿大

```javascript
phone('(817) 569-8900'); // return ['+18175698900, 'USA']
phone('(817) 569-8900', ''); // return ['+18175698900, 'USA']
phone('(817) 569-8900', ''); // return ['+18175698900', 'USA']
phone('780-569-8900', ''); // return ['+17805698900, 'CAN'], 780 is a Canada phone prefix
phone('6123-6123', ''); // return [], as default country is USA / CAN and it does not match any result
```

如果您想要跳过电话号码初始数字检查, 请设定 `allowLandline` 改为正 :

```javascript
phone('+(852) 2356-4902', '', true);
```

初始数字检查将被完全禁用, 即使你输入一个电话号码开始 一个无性别化的数字:

```javascript
phone('+(852) 0356-4902', '', true); // return [ '+85203564902', 'HKG' ], even the phone number start with `0` is not a valid landline phone number
```

## API 密码

```javascript
const phone = require('phonenumbers');
```

### `phone(phone: String, [country: string, allowLandline: Boolean]): Array`

#### 投入

| 参数 | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| 电话 | 字符串 | 对 | 您想要处理的电话号码文本 |
| 国家 | 字符串 | 没有 | 以等值-3166 α 2 或 3 格式提供国家代码 |
| 允许行线 | 布尔 | 没有 | 如果您想要跳过电话号码初始数字检查, 则设定为真 |

#### 回返

归来总是个阵列

| 阵列索引 | 类型 | 说明 |
| --- | --- | --- |
| 0 个 | 字符串 | E.164格式的正常电话号码 |
| 1个 | 字符串 | 检测到的以等值-3166 α 3 为格式的电话号码国家代码 |

如果由于任何原因(如无法与任何国家相匹配)无法重排电话号码,结果将是空数组.

出于一些历史原因,函数响应采用矩阵格式,预计在下个大版本起伏时会被更新为合适的对象响应. (不会更改 2.x 版本)

## 测试

```
yarn test
```

## 构建

```
yarn build
```

## 旧浏览器支持( B)

目前我们转接脚本,用于针对浏览器全球使用率为 >1%的目标环境,以及Node.js 6.10+.

您可以检查浏览器使用统计 [浏览器列表](http://browserl.ist/?q=%3E1%25)。 。 。 .

您可能需要一些更老的浏览器的多填充; 更多细节请阅读 `example/README` 文档.

## 财务问题

1.  对 `phonenumber` 有逻辑验证吗?
    
    对 如果您提供了第2个参数( 国家), 且电话号码不以 `+` 签名.
    
    `phonenumber` 将验证 `mobile_number_lengths` 财务报告和审定财务报表 `mobile_begin_with`
    
2.  为什么 `phonenumber` 要返回无效的电话号码吗 ?
    
    默认情况下,该功能将只验证一个手机号码,以验证一个地上电话号码,请设置第3个参数 `allowLandline` 真实的.
    
    如果你发现结果仍然不正确,请提交一张票来改进我们的验证规则.
    
3.  怎么样 `allowLandline` 工作吗?
    
    手机号码检测是通过比较一个电话号码的起始数字和一个国家可能移动前缀列表来实现的. 在一些国家,移动电话和地线的部分或全部前缀相同 `allowLandline` 设置为 `false` 您不应假设所有可能的地上电话号码都会被可靠地过滤出.
    

## 帮助

我们试图确保这个套案能处理尽可能多的案件, 如果你注意到我们对一个国家或其他案件有错误的规则, 请打开一个问题让我们知道.

为创建关于添加或修改电话号码格式的新拉取请求,请提供PDF,网站等参考信息. 非常感谢.

## 许可证

本项目根据以下规定获得许可证: [麻省理工学院许可证](https://github.com/AfterShip/phone/blob/master/LICENSE)。 。 。 .

## 常见问题

### @foerster-technologies/phonenumbers 是什么？

使用特定国家和电话号码,验证电话号码并将其格式化为E\.164标准

### 如何安装 @foerster-technologies/phonenumbers？

在项目目录运行 npm install @foerster-technologies/phonenumbers，或使用 pnpm add / yarn add / bun add。

### @foerster-technologies/phonenumbers 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/foerster-technologies\_\_phonenumbers 是否存在。

### @foerster-technologies/phonenumbers 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @foerster-technologies/phonenumbers 需要什么版本的 Node\.js？

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

### @foerster-technologies/phonenumbers 可以商用吗？

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

### @foerster-technologies/phonenumbers 的下载量有多少？

根据 npm 官方下载统计，@foerster-technologies/phonenumbers 在 2026/10/15 – 2026/11/13 这 30 天内被下载 2,328 次，日均约 78 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @foerster-technologies/phonenumbers 还在维护吗？

最新版本 1\.0\.2 发布于 2020/08/05（6 年前）；至今共发布 3 个版本，其中过去 12 个月发布了 0 个；首次发布于 2020/08/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。