# @fnando/cpf 中文文档

规范地址：https://npmcn.com/package/%40fnando/cpf/

版本：1\.0\.2
npm 元数据更新时间：2022-04-05T11:34:10.381Z
中文译文更新时间：2026-11-15T03:21:50.841Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：44.1 kB，19 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2018-04-04T13:36:48.030Z
- 最新版本发布：2020-07-21T19:00:25.214Z
- 近 30 天下载量：135241（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 0 个）

## 中文简介

验证、生成和格式化CPF数字

## 安装

```sh
npm install @fnando/cpf
```

也可以使用：`pnpm add @fnando/cpf`、`yarn add @fnando/cpf`、`bun add @fnando/cpf`

## README

# 森林合作伙伴关系

[![Build Status](https://travis-ci.org/fnando/cpf.svg?branch=master)](https://travis-ci.org/fnando/cpf) [![NPM package version](https://img.shields.io/npm/v/@fnando/cpf.svg)](https://www.npmjs.com/package/@fnando/cpf) ![License: MIT](https://img.shields.io/npm/l/@fnando/cpf.svg) ![Minified size](http://img.badgesize.io/fnando/cpf/master/web/cpf.min.js.svg?label=cpf+min+size) ![Minified+Gzip size](http://img.badgesize.io/fnando/cpf/master/web/cpf.min.js.svg?compression=gzip&label=cpf+min%2Bgzip+size)

这个软件包做一些 [森林合作伙伴关系](http://en.wikipedia.org/wiki/Cadastro_de_Pessoas_F%C3%ADsicas) 魔术 这个 允许您创建、验证和格式化CPF文档.

**汉特:** 请检查access-date=中的日期值 (帮助) CNPJ柜台部分 [https://github.com/fnando/cnpj 页面存档备份,存于互联网档案馆](https://github.com/fnando/cnpj)。 。 。 .

## 安装

这一自由作为国家防范机制的一揽子方案提供。 要安装它,请使用以下 命令 :

```
npm install @fnando/cpf --save
```

如果你用雅恩(你应该):

```
yarn add @fnando/cpf
```

## 使用量

```js
// Node.js-specific
const cpf = require("@fnando/cpf/commonjs");

// @import
import * as cpf from "@fnando/cpf"; // import the whole library
import { isValid as isValidCpf } from "@fnando/cpf"; // import just one function

// import via <script>; the lib will available as window.cpf
// <script src="cpf.js"></script>

cpf.isValid("532.820.857-96");
//=> true

cpf.isValid("53282085796");
//=> true

cpf.strip("532.820.857-96");
//=> 53282085796

cpf.format("53282085796");
//=> 532.820.857-96

cpf.generate(true); // generate formatted number
//=> 838.684.734-40

cpf.generate(); // generate unformatted number
//=> 72777632898
```

在网络上,没有转换,只是使用 `web/cpf.min.js`。 。 。 .

### 严格校验

默认情况下,验证会剥去您提供的任何字符. 这意味着 以下内容有效,因为只考虑数字:

```js
cpf.isValid("101#688!!!!!!542......36");
//=> true

cpf.strip("101#688!!!!!!542......36");
//=> 10168854236
```

如果要严格验证字符串,请使用以下签名:

```js
cpf.isValid(number, strict);
```

同样的榜样现在又会回归 `false`数字 :

```js
cpf.isValid("101#688!!!!!!542......36", true);
//=> false
```

## 常见问题

### @fnando/cpf 是什么？

验证、生成和格式化CPF数字

### 如何安装 @fnando/cpf？

在项目目录运行 npm install @fnando/cpf，或使用 pnpm add / yarn add / bun add。

### @fnando/cpf 支持 TypeScript 吗？

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

### @fnando/cpf 支持 ESM 还是 CommonJS？

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

### @fnando/cpf 可以商用吗？

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

### @fnando/cpf 的下载量有多少？

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

### @fnando/cpf 还在维护吗？

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