@4us-dev/utils 中文文档教程

Question

4us-dev utils

使用 npm

npm i @4us-dev/utils

Usage

• StringUtils
• isBlank and isNotBlank
• isEmpty and isNotEmpty
• hideEmail
• removeNonNumeric
• isInteger
• isDouble
• RandomUtils
• nextInt
• nextString
• nextStringCustom
• FormatUtils
• formatCPF
• formatCNPJ
• formatPhone
• formatCEP
• onlyIntegers
• BrazilianUtils
• isCPF
• isCNPJ
• generateCPF
• generateCNPJ

Introduction

@4us-dev/utils 是一个带有实用方法的库，可在软件开发过程中帮助开发人员。 它的开发考虑了最佳实践，并有助于对代码进行单元测试。 因此，它没有任何静态方法，从而有助于在必要时在测试期间进行模拟。

StringUtils

isBlank and isNotBlank

如果值为 null、未定义、空或只有空格的字符串，则 isBlank 返回 true。

示例：

new StringUtils().isBlank(null); // true
new StringUtils().isBlank(undefined); // true
new StringUtils().isBlank(''); // true
new StringUtils().isBlank('  '); // true
new StringUtils().isBlank('a'); // false

new StringUtils().isNotBlank(value) 等于 !new StringUtils().isBlank(value)

isEmpty and isNotEmpty

isEmpty 如果值为 null、未定义或为空，则返回 true .

示例：

new StringUtils().isEmpty(null); // true
new StringUtils().isEmpty(undefined); // true
new StringUtils().isEmpty(''); // true
new StringUtils().isEmpty('  '); // false
new StringUtils().isEmpty('a'); // false

new StringUtils().isNotEmpty(value) 等于 !new StringUtils().isEmpty(value)

hideEmail

隐藏部分电子邮件。 您可以隐藏电子邮件的开头和/或结尾。

示例：

默认配置

new StringUtils().hideEmail(`fulano@gmail.com`); // `f...@gmail.com`

如何使用电子邮件的结尾

new StringUtils().hideEmail(`fulano@gmail.com`, {
  hideStart: true, // default true
  hideEnd: true, // default false
}); // `f...@gma...`

如果通知的 email 不包含 @ 或者是 null 或 undefined< /代码> 该方法的返回值将为 undefined

new StringUtils().hideEmail(`fulano.com`); // undefined
new StringUtils().hideEmail(``); // undefined
new StringUtils().hideEmail(``); // undefined
new StringUtils().hideEmail(null); // undefined

removeNonNumeric

从字符串中删除所有非数字字符。

示例：

new StringUtils().removeNonNumeric('a1b2c3'); // '123'

isInteger

如果值仅包含数值，则

返回 true示例：

new StringUtils().isInteger('123'); // true
new StringUtils().isInteger('12.3'); // false
new StringUtils().isInteger('12,3'); // false
new StringUtils().isInteger('a1b2c3'); // false
new StringUtils().isInteger(' 123 '); // false

isDouble

如果字符串中的值是双

精度值，则返回 true示例：

new StringUtils().isDouble('123'); // true
new StringUtils().isDouble('12.3'); // true
new StringUtils().isDouble('12,3'); // false
new StringUtils().isDouble('a1b2c3'); // false
new StringUtils().isDouble(' 123 '); // false

RandomUtils

nextInt

生成介于 min 和 max 之间的随机整数（含）。

示例：

// the return a integer between 0 and 100 inclusive
const value = new RandomUtils().getRandomInteger();

// the return can be one of this values 0, 1, 2 or 3
const value = new RandomUtils().getRandomInteger({ min: 0, max: 3 });

nextString

生成一个随机字符串。

示例：

// returns a random string with length 16
const value = new RandomUtils().nextString();

// returns a random string with length 8
const value = new RandomUtils().nextString({ length: 8 });

// returns a random string with length 8 only with letters upper, letters lower and numbers
const value = new RandomUtils().nextString({
  length: 8, // default 16
  upper: true, // default true ex: ABCDEF...
  lower: true, // default true ex: abcdef...
  numbers: true, // default true ex: 012345...
  specialSimple: false, // default true ex: !#$%&*_+=-^~?;:.,|
  specialAmbiguous: false, // default true ex: "()\'`´{[]}/><
});

nextStringCustom

生成一个随机字符串，其中包含 length 信息，并使用 caracteresAllowed 变量作为参考。

示例：

// returns a random string with length 10 using only `A`, `1` or `c` to generate the result
const value = new RandomUtils().nextStringCustom(10, 'A1c');

FormatUtils

formatCPF

删除所有非数字值并应用 CPF 掩码。

示例：

const value = new FormatUtils().formatCPF('66273306010'); // "662.733.060-10"

这应该像这样部分格式化 CPF

const value = new FormatUtils().formatCPF('6627330'); // "662.733.0"

如果值包含非数字字符，它们将在格式化时被删除

const value = new FormatUtils().formatCPF('66A27B33C060D10'); // "662.733.060-10"

formatCNPJ

删除所有非数字值并应用 CNPJ 掩码。

示例：

const value = new FormatUtils().formatCNPJ('94338204000180'); // "94.338.204/0001-80"

这应该像这样部分格式化 CNPJ

const value = new FormatUtils().formatCNPJ('9433820'); // "94.338.20"

如果值包含非数字字符，它们将在格式化时被删除

const value = new FormatUtils().formatCNPJ('943A382B04000C180'); // "94.338.204/0001-80"

formatPhone

删除所有非数字值并应用电话掩码 (99)9999-9999 或 (99)99999-9999。

示例：

const value = new FormatUtils().formatPhone('85999432345'); // "(85)99943-2345"
const value = new FormatUtils().formatPhone('8599943234'); // "(85)9994-3234"

这应该像这样部分格式化电话

const value = new FormatUtils().formatPhone('8599943'); // "(85)9994-3"

如果值包含非数字字符，它们将在格式化时被删除

const value = new FormatUtils().formatPhone('A8B5C9D9f9g4h3i23s4w5q'); // "(85)99943-2345"

formatCEP

删除所有非数字值并应用 CEP 掩码 99999-999

示例：

const value = new FormatUtils().formatPhone('60601023'); // "60601-023"

这应该像这样部分格式化 cep

const value = new FormatUtils().formatPhone('606010'); // "60601-0"

如果value contains non-numeric characters they will be removed in formatting

const value = new FormatUtils().formatPhone('A60b601c02D3E'); // "60601-023"

formatOnlyIntegers

从字符串中删除所有非数字字符。

示例：

const value = new FormatUtils().formatOnlyIntegers('a1b2c3'); // '123'060-10"

BrazilianUtils

isCPF

当 CPF 有效时

返回真示例：

const brazilianUtils = new BrazilianUtils();

if (brazilianUtils.isCPF('66273306010')) {
  console.log('CPF is valid');
} else {
  console.log('CPF is not valid');
}

或

if (brazilianUtils.isCPF('662.733.060-10')) {
  console.log('CPF is valid');
} else {
  console.log('CPF is not valid');
}

isCNPJ

当 CNPJ 有效时返回真

示例：

const brazilianUtils = new BrazilianUtils();

if (brazilianUtils.isCNPJ('94338204000180')) {
  console.log('CNPJ is valid');
} else {
  console.log('CNPJ is not valid');
}

或

if (brazilianUtils.isCNPJ('94.338.204/0001-80')) {
  console.log('CNPJ is valid');
} else {
  console.log('CNPJ is not valid');
}

generateCPF

返回有效的 CPF

示例：

const brazilianUtils = new BrazilianUtils();

const cpf = brazilianUtils.generateCPF();

generateCNPJ

返回有效的 CNPJ

示例：

const brazilianUtils = new BrazilianUtils();

const cpf = brazilianUtils.generateCNPJ();