介绍
npm 包 brazilian 是一个 JavaScript 库，旨在帮助开发者处理巴西相关的数据，例如 CPF（巴西公民身份证号码）、CNPJ（巴西公司税务登记号码）、状态码、电话号码等。该库提供了若干函数，开发者可以借助它们快速处理巴西相关的数据。
本文将详细介绍 npm 包 brazilian 的使用方法，帮助开发者更好地使用该库。
安装 brazilian
在使用 brazilian 库之前，我们需要将其安装到我们的项目中。你可以通过以下命令来安装 brazilian：
npm i brazilian
使用 brazilian
brazilian 库的 API 非常简单明了，我们只需要将需要处理的数据作为参数传入对应的函数即可。下面是 brazilian 库提供的函数列表：
isCPF(cpf)
参数：cpf（字符串类型，长度为11）
返回值：true 或 false
isCPF 函数可以用于检测一个字符串是否是合法的 CPF 号码。如果传入的字符串是一个合法的 CPF 号码，则返回 true，否则返回 false。例如：
const brazilian = require('brazilian')
console.log(brazilian.isCPF('12345678901')) // false
console.log(brazilian.isCPF('39744997847')) // trueformatCPF(cpf)
参数：cpf（字符串类型，长度为11）
返回值：格式化后的字符串，形如「XXX.XXX.XXX-XX」
formatCPF 函数用于将传入的 CPF 号码进行格式化。它会将传入的字符串按照「XXX.XXX.XXX-XX」的格式进行输出。例如：
const brazilian = require('brazilian')
console.log(brazilian.formatCPF('12345678901')) // false
console.log(brazilian.formatCPF('39744997847')) // "397.449.978-47"isCNPJ(cnpj)
参数：cnpj（字符串类型，长度为14）
返回值：true 或 false
isCNPJ 函数可以用于检测一个字符串是否是合法的 CNPJ 号码。如果传入的字符串是一个合法的 CNPJ 号码，则返回 true，否则返回 false。例如：
const brazilian = require('brazilian')
console.log(brazilian.isCNPJ('12345678901234')) // false
console.log(brazilian.isCNPJ('36490578000109')) // trueformatCNPJ(cnpj)
参数：cnpj（字符串类型，长度为14）
返回值：格式化后的字符串，形如「XX.XXX.XXX/YYYY-ZZ」
formatCNPJ 函数用于将传入的 CNPJ 号码进行格式化。它会将传入的字符串按照「XX.XXX.XXX/YYYY-ZZ」的格式进行输出。例如：
const brazilian = require('brazilian')
console.log(brazilian.formatCNPJ('12345678901234')) // "12.345.678/9012-34"
console.log(brazilian.formatCNPJ('36490578000109')) // "36.490.578/0001-09"isCEP(cep)
参数：cep（字符串类型，长度为8）
返回值：true 或 false
isCEP 函数可以用于检测一个字符串是否是合法的 CEP 编码。如果传入的字符串是一个合法的 CEP 编码，则返回 true，否则返回 false。例如：
const brazilian = require('brazilian')
console.log(brazilian.isCEP('12345678')) // false
console.log(brazilian.isCEP('91540010')) // trueformatCEP(cep)
参数：cep（字符串类型，长度为8）
返回值：格式化后的字符串，形如「XXXXX-XXX」
formatCEP 函数用于将传入的 CEP 编码进行格式化。它会将传入的字符串按照「XXXXX-XXX」的格式进行输出。例如：
const brazilian = require('brazilian')
console.log(brazilian.formatCEP('12345678')) // "12345-678"
console.log(brazilian.formatCEP('91540010')) // "91540-010"isPhone(phone)
参数：phone（字符串类型）
返回值：true 或 false
isPhone 函数可以用于检测一个字符串是否是合法的巴西电话号码。如果传入的字符串是一个合法的电话号码，则返回 true，否则返回 false。例如：
const brazilian = require('brazilian')
console.log(brazilian.isPhone('(123) 456-7890')) // false
console.log(brazilian.isPhone('(11) 91234-5678')) // trueformatPhone(phone)
参数：phone（字符串类型）
返回值：格式化后的字符串，形如「(XX) XXXXX-XXXX」
formatPhone 函数用于将传入的电话号码进行格式化。它会将传入的字符串按照「(XX) XXXXX-XXXX」的格式进行输出。例如：
const brazilian = require('brazilian')
console.log(brazilian.formatPhone('(123) 456-7890')) // "(123) 456-7890"
console.log(brazilian.formatPhone('(11) 91234-5678')) // "(11) 91234-5678"getStates()
参数：无
返回值：巴西各州的对象数组
getStates 函数会返回一个包含巴西各州名称、简称和区号的对象数组。例如：
-- -------------------- ---- ------- ----- --------- - -------------------- ---------------------------------- -- - - ----- ------- ------------- ----- ------ -- -- - ----- ---------- ------------- ----- ------ -- -- - ----- ----------- ------------- ----- ------ -- -- - ----- -------- ------------- ----- ------ -- -- - ----- -------- ------------- ----- ------ -- -- - ----- -------- ------------- ----- ------ -- -- - ----- --------- --------- ------------- ----- ------ -- -- - ----- --------- ------- ------------- ----- ------ -- -- - ----- -------- ------------- ----- ------ -- -- - ----- ----------- ------------- ----- ------ -- -- - ----- ------ -------- ------------- ----- ------ -- -- - ----- ----- ------ -- ----- ------------- ----- ------ -- -- - ----- ----- -------- ------------- ----- ------ -- -- - ----- ------- ------------- ----- ------ -- -- - ----- ---------- ------------- ----- ------ -- -- - ----- ------------- ------------- ----- ------ -- -- - ----- -------- ------------- ----- ------ -- -- - ----- --------- ------------- ----- ------ -- -- - ----- ---- -- --------- ------------- ----- ------ -- -- - ----- ---- ------ -- ------- ------------- ----- ------ -- -- - ----- ----------- ------------- ----- ------ -- -- - ----- ---------- ------------- ----- ------ -- -- - ----- ---- ------ -- ----- ------------- ----- ------ -- -- - ----- ------ ---------- ------------- ----- ------ -- -- - ----- ---------- ------------- ----- ------ -- -- - ----- ---- ------- ------------- ----- ------ -- -- - ----- ------------ ------------- ----- ------ -- - - --
getStateAbbreviation(stateName)
参数：stateName（字符串类型）
返回值：对应州的简称
getStateAbbreviation 函数会根据传入的州名返回对应州的简称。例如：
const brazilian = require('brazilian')
console.log(brazilian.getStateAbbreviation('São Paulo')) // "SP"
console.log(brazilian.getStateAbbreviation('Minas Gerais')) // "MG"getStateName(abbreviation)
参数：abbreviation（字符串类型）
返回值：对应州的州名
getStateName 函数会根据传入的州简称返回对应州的名称。例如：
const brazilian = require('brazilian')
console.log(brazilian.getStateName('SP')) // "São Paulo"
console.log(brazilian.getStateName('MG')) // "Minas Gerais"示例代码
下面是一个使用 brazilian 库进行 CPF 格式化和检测的示例代码：
-- -------------------- ---- ------- ----- --------- - -------------------- ----- --- - ------------- -- ---------------------- - ----- ------------ - ------------------------ ----------------- --- --------------------- - ---- - --------------------------- --- ----- -
上述代码会检测传入的字符串是否是一个合法的 CPF 号码，如果是的话就将其格式化输出。如果不是，则输出一条错误提示。
总结
本文介绍了如何使用 brazilian 库来处理巴西相关的数据。该库提供了一系列函数，可以用于检测和格式化 CPF、CNPJ、电话号码和 CEP 等数据。本文中详细介绍了这些函数的使用方法，并配有示例代码，方便开发者理解和应用。
如果你正在开发一款面向巴西用户的 Web 应用，那么 brazilian 库无疑是一个非常实用的工具。相信本文能够帮助你理解并掌握该库的使用方法，如果你还有其他疑问，欢迎在评论区提出。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066c86ccdc64669dde4f3c