kuze-utils

Instalação

A biblioteca está publicada no NPM, então para adicioná-la ao projeto, basta executar o comando:

npm i kuze-utils

ou, caso esteja usando yarn, execute o comando

yarn add kuze-utils

---

Métodos

validateCPF

Retorna um boolean se o CPF informado é válido ou não.

import { validateCPF } from 'kuze-utils';

validateCPF('03455455787'); // true/false

maskCPF

Adicionar máscara ao número de CPF informado.

import { maskCPF } from 'kuze-utils';

maskCPF('28832326280'); // 288.323.262-80

unmaskCPF

Remove a máscara do número de CPF informado, retornando apenas os números.

import { unmaskCPF } from 'kuze-utils';

unmaskCPF('288.323.262-80'); // 28832326280

validateCNPJ

Retorna um boolean se o CNPJ informado é válido ou não.

import { validateCNPJ } from 'kuze-utils';

validateCNPJ('17702663000150'); // true/false

maskCNPJ

Adicionar máscara ao número de CNPJ informado.

import { maskCNPJ } from 'kuze-utils';

maskCNPJ('17702663000150'); // 17.702.663/0001-50

unmaskCNPJ

Remove a máscara do número de CNPJ informado, retornando apenas os números.

import { unmaskCNPJ } from 'kuze-utils';

unmaskCNPJ('17.702.663/0001-50'); // 17702663000150

validateCreditCardNumber

Retorna um boolean se o número de cartão de crédito informado é válido ou não.

import { validateCreditCardNumber } from 'kuze-utils';

validateCreditCardNumber('5598928852411791'); // true/false

validateCreditCardExpiration

Retorna um boolean se a data de expiração do cartão de crédito informado é válido ou não.

import { validateCreditCardExpiration } from 'kuze-utils';

validateCreditCardExpiration('12/22'); // true/false

getCardBrand

Retorna uma string com a bandeira do cartão através do número informado (cardNumber). Os possíveis retornos são:

• Elo,
• HiperCard,
• Visa,
• MasterCard,
• JCB,
• Diners Club,
• Discover,
• American Express.

import { getCardBrand } from 'kuze-utils';

getCardBrand('5284929298198314'); 

/*
retorna: "MasterCard"
*/

getCreditCardInfo

Retorna um object com informações sobre o número de cartão de crédito informado.

import { getCreditCardInfo } from 'kuze-utils';

getCreditCardInfo('5485775006283622'); 

/*
retorna:

{
    card: {
      niceType: 'Mastercard',
      type: 'mastercard',
      patterns: [[51, 55], [2221, 2229], [223, 229], [23, 26], [270, 271], 2720],
      gaps: [4, 8, 12],
      lengths: [16],
      code: { name: 'CVC', size: 3 },
      matchStrength: 2,
    },
    isPotentiallyValid: false,
    isValid: false,
  };
*/

getNameInitials

Retorna uma string com as letras iniciais do nome informado

import { getNameInitials } from 'kuze-utils';

getNameInitials('Bora testar'); // BT

validatePhone

Retorna um boolean se o número de telefone informado é válido ou não.

import { validatePhone } from 'kuze-utils';

validatePhone('(11) 99989-8887'); // true/false

maskPhone

Adicionar máscara ao número de telefone informado.

import { maskPhone } from 'kuze-utils';

maskPhone('11999898887'); // (11) 99989-8887

unmaskPhone

Remove a máscara do número de telefone informado, retornando apenas os números.

import { unmaskPhone } from 'kuze-utils';

unmaskPhone('(11) 99989-8887'); // 11999898887

capitalize

Torna maiúscula apenas a primeira letra de cada palavra da frase informada.

import { capitalize } from 'kuze-utils';

capitalize("Apenas pra gente TESTAR"); // Apenas Pra Gente Testar

---

Brazilian utils

Essa lib expoe algumas funções diretamente da biblioteca brazilian-utils.

São elas:

isValidBoleto

Retorna um boolean se o número de boleto informado é válido ou não.

import { isValidBoleto } from 'kuze-utils';

isValidBoleto('00190000090114971860168524522114675860000102656'); // true

formatBoleto

Adiciona a máscara com pontuação ao número de boleto informado.

import { formatBoleto } from 'kuze-utils';

formatBoleto('00190000090114971860168524522114675860000102656');

isValidCEP

Retorna um boolean se o CEP informado é válido ou não.

import { isValidCEP } from 'kuze-utils';

isValidCEP('92500000'); // true

formatCEP

Adicionar máscara ao número de CEP informado.

import { formatCEP } from 'kuze-utils';

formatCEP('92500000'); // 92500-000

isValidCNPJ

Retorna um boolean se o CNPJ informado é válido ou não.

import { isValidCNPJ } from 'kuze-utils';

isValidCNPJ('15515147234255'); // true/false

formatCNPJ

Adicionar máscara ao número de CNPJ informado.

import { formatCNPJ } from 'kuze-utils';

formatCNPJ('245222000174'); // 24.522.200/0174

isValidCPF

Retorna um boolean se o CPF informado é válido ou não.

import { isValidCPF } from 'kuze-utils';

isValidCPF('155151475'); // true/false

formatCPF

Adicionar máscara ao número de CPF informado.

import { formatCPF } from 'kuze-utils';

formatCPF('746506880'); // 746.506.880

isValidPIS

Retorna um boolean se o CPF informado é válido ou não.

import { isValidPIS } from 'kuze-utils';

isValidPIS('12056412547'); // true/false

isValidEmail

Retorna um boolean se o CPF informado é válido ou não.

import { isValidEmail } from 'kuze-utils';

isValidEmail('[e-mail]'); // true