vitorluizc / brazilian-values Goto Github PK

🇧🇷 Funções de formatação, conversão e validação para valores, documentos e outras unidades usadas no Brasil. Como CEP, CNPJ, CPF, BRL (R$), datas, números etc.

License: MIT License

TypeScript 99.44% JavaScript 0.24% Dockerfile 0.32%

formatters brazilian brazilian-portuguese validators cnpj-validator cpf-validator cpf-validador cnpj cpj cep

brazilian-values's Introduction

Brazilian Values

🇺🇸 Switch to english version

Validar e formatar valores brasileiros como dinheiro (BRL), CPF, CNPJ, datas etc.

Instalação

Este módulo está publicado no NPM, por isso você pode instalar usando qualquer gerenciador de pacotes Node.js.

npm install brazilian-values --save

# Use o comando abaixo para o Yarn.
yarn add brazilian-values

Instalação por CDN

Os pacotes desse módulo também estão disponíveis nas CDNs JSDelivr e UNPKG.

Em ambas você pode solicitar o pacote desejado ou usar o padrão, que é o UMD.

<!-- Usando o pacote padrão com o JSDelivr -->
<script src="https://cdn.jsdelivr.net/npm/brazilian-values"></script>

<!-- Usando o pacote padrão com o UNPKG -->
<script src="https://unpkg.com/brazilian-values"></script>

<script>
  /**
   * O pacote UMD expõe o brazilian-values com o objeto `BrazilianValues`.
   */
  BrazilianValues.formatToBRL(100);
  //=> 'R$ 100,00'
</script>

Como usar

brazilian-values fornece funções para lidar com formatação, validação e conversão de valores brasileiros. Todas essas funções podem ser importadas do pacote.

import { isCNPJ, formatToCNPJ } from 'brazilian-values';

const value = '12727442000113'

if (!isCNPJ(value))
  throw new Error('CNPJ is not valid.');
const document = formatToCNPJ(value);
//=> '12.727.442/0001-13'

API

Formatadores

formatToBRL
formatToCapitalized
formatToCEP
formatToCNPJ
formatToCAEPF
formatToCPF
formatToCPFOrCNPJ
formatToDate
formatToDateTime
formatToList
formatToNumber
formatToPhone
formatToRG
formatToHiddenDigits

Conversores

parseToArray
parseToDate
parseToNumber

Validadores

isCEP
isCNPJ
isCAEPF
isCPF
isCPFOrCNPJ
isDate
isDDD
isPhone

Formatação

`formatToBRL`

Formata números ou string que contém números para a moeda brasileira (BRL).

formatToBRL(1928.93)
//=> 'R$ 1.928,93'

formatToBRL('9211928.18203')
//=> 'R$ 9.211.928,18'

formatToBRL(-18.49)
//=> 'R$ -18,49'

`formatToCapitalized`

Capitaliza as palavras de um texto, com exceção das palavras configuradas para serem deixadas em caixa-alta ou em caixa-baixa.

A primeira palavra do texto não será caixa-baixa mesmo se configurada como.

formatToCapitalized('SERVIDOR PÚBLICO MUNICIPAL')
//=> 'Servidor Público Municipal'

formatToCapitalized('   os PrimEIROS  HOMens da tERra', {
  wordsToKeepLowerCase: ['os', 'da']
})
//=> 'Os Primeiros Homens da Terra'

formatToCapitalized('nova tv foi lançada', {
  wordsToKeepUpperCase: ['tv']
})
//=> 'Nova TV Foi Lançada'

formatToCapitalized(' com espaços antes e depois ', {
  trimTrailingWhiteSpaces: false
})
//=> ' Com Espaços Antes e Depois '

`formatToCEP`

Formata uma string que contém números em CEP.

formatToCEP('15998030')
//=> '15998-030'

formatToCEP('02999')
//=> '02999'

`formatToCNPJ`

Formata uma string que contém números em CNPJ.

formatToCNPJ('128781')
//=> '12.878.1'

formatToCNPJ('32284981000138')
//=> '32.284.981/0001-38'

formatToCNPJ('00.0.000.00.00--00-00')
//=> '00.000.000/0000-00'

`formatToCAEPF`

Formata uma string que contém números em CAEPF.

formatToCAEPF('128781')
//=> '128.781'

formatToCAEPF('32284981000150')
//=> '322.849.810/001-50'

formatToCAEPF('00.0.000.00.00--00-00')
//=> '000.000.000/000-00'

`formatToCPF`

Formata uma string que contém números em CPF.

formatToCPF('00000000')
//=> '000.000.00'

formatToCPF('00000000000')
//=> '000.000.000-00'

formatToCPF('366.418.768-70')
//=> '366.418.768-70'

`formatToCPFOrCNPJ`

Formata uma string que contém números em CPF ou CNPJ dependendo da quantidade de caracteres.

formatToCPFOrCNPJ('00000000')
//=> '000.000.00'

formatToCPFOrCNPJ('366.418.768-70')
//=> '366.418.768-70'

formatToCPFOrCNPJ('32284981000138')
//=> '32.284.981/0001-38'

formatToCPFOrCNPJ('00.0.000.00.00--00-00')
//=> '00.000.000/0000-00'

`formatToDate`

Formata uma instância de Date para o estilo brasileiro, DD/MM/YYYY.

formatToDate(new Date(2002, 7, 21))
//=> '21/08/2002'

formatToDate(new Date())
//=> '08/09/2018'

`formatToDateTime`

Formata uma instância de Date para o data e horário no formato brasileiro, DD/MM/YYYY HH:mm.

formatToDateTime(new Date(2002, 7, 21, 18, 30))
//=> '21/08/2002 18:30'

`formatToList`

Formata os valores de um Array de string no estilo brasileiro.

formatToList(['Vitor', 'William', 'Fernando'])
//=> 'Vitor, William e Fernando'

formatToList([])
// => ''

formatToList(['1', '2'])
// => '1 e 2'

formatToList(['Direito Civil'])
//=> 'Direito Civil'

`formatToNumber`

Formata um número para o estilo brasileiro.

formatToNumber(0)
//=> '0'

formatToNumber(-1299)
//=> '-1.299'

formatToNumber(.981)
//=> '0,981'

formatToNumber('19898.1298')
//=> '19.898,1298'

`formatToPhone`

Formata uma string contendo números para o estilo do número de telefone brasileiro.

formatToPhone('11')
//=> '(11'

formatToPhone('11971626')
//=> '(11) 9716-26'

formatToPhone('11971626799')
//=> '(11) 9 7162-6799'

`formatToRG`

Formata uma string contendo números para RG.

Hoje, brazilian-values suporta apenas os formatos de SP e RJ.
Outros valores serão apenas "escapados" no input.

formatToRG('00000000A', 'SP')
//=> '00.000.000-A'

formatToRG('00.00.0000-0', 'RJ')
//=> '00.000.000-0'

formatToRG('MG-14.808.688', 'MG')
//=> 'MG-14.808.688'

`formatToHiddenDigits`

Formata uma string contendo dígitos substituindo os dígitos dentro do intervalo pelo caractere oculto (hider).

O intervalo pode receber números positivos ou negativos como atalho para o intervalo. Nesse caso o 2 equivale aos primeiros dois dígitos, e -3 aos últimos três dígitos.

O intervalo padrão são os três primeiros dígitos, e o caractere oculto padrão é o "*" (asterísco).

formatToHiddenDigits('00.000-000')
//=> '**.*00-000'

formatToHiddenDigits('03/04/2002', { hider: '-' })
//=> '--/-4/2002'

formatToHiddenDigits('111.111.111-11', { range: [4, 9] })
//=> '111.***.***-11'

formatToHiddenDigits('12.345.678-9', { hider: '#', range: 5 })
//=> '##.###.678-9'

formatToHiddenDigits('52.715.348/0001-69', { hider: '@', range: -9 })
//=> '52.715.@@@/@@@@-@@'

Conversores

`parseToArray`

Converte uma lista no formato brasileiro para um Array de string.

parseToArray('')
//=> []

parseToArray('1')
//=> ['1']

parseToArray('1 e 2')
//=> ['1', '2']

parseToArray('Fernanda, Luana e Ana Carolina')
//=> ['Fernanda', 'Luana', 'Ana Carolina']

`parseToDate`

Converte a data no formato brasileiro para uma instância de Date.

Lança um erro se o valor for inválido ou não corresponder a o formato de data brasileiro.

parseToDate('28/03/1996')
//=> Date('1996-03-28T03:00:00.000Z')

parseToDate('28/03/1996 20:00')
//=> Date('1996-03-28T23:00:00.000Z')

parseToDate('28/03/1996 20:00:00')
//=> Date('1996-03-28T23:00:00.000Z')

parseToDate('31/02/2018')
//=> throws Error('Value "31/02/2018" is an invalid date.')

`parseToNumber`

Converte o número no estilo brasileiro para um número.

parseToNumber('10')
//=> 10

parseToNumber('-1.299')
//=> -1299

parseToNumber('0,981')
//=> 0.981

parseToNumber('19.898,1298')
//=> 19898.1298

Validadores

`isCEP`

Verifica se é um CEP válido.

isCEP('50.833-000')
//=> true

isCEP('02998-050')
//=> true

isCEP('00000000')
//=> true

isCEP('0')
//=> false

isCEP('1982891928981982198')
//=> false

`isCNPJ`

Verifica se é um CNPJ válido.

Relacionado: isCPFOrCNPJ.

isCNPJ('41142260000189')
//=> true

isCNPJ('45.723.174/0001-10')
//=> true

isCNPJ('411407182')
//=> false

isCNPJ('11.111.111/1111-11')
//=> false

`isCAEPF`

Verifica se é um CAEPF válido.

isCAEPF('45723174000122')
//=> true

isCAEPF('457.231.740/001-22')
//=> false

isCAEPF('45.723.174/0001-22')
//=> false

isCAEPF('411407182')
//=> false

isCAEPF('111.111.111/111-11')
//=> false

`isCPF`

Verifica se é um CPF válido.

Relacionado: isCPFOrCNPJ.

isCPF('366.418.768-70')
//=> true

isCPF('36641876870')
//=> true

isCPF('213.198.013-20')
//=> false

isCPF('2131201872781')
//=> false

isCPF('11111111111')
//=> false

`isCPFOrCNPJ`

Verifica se é um CPF ou um CNPJ válido.

Relacionado: isCPF, isCNPJ.

isCPFOrCNPJ('366.418.768-70')
//=> true

isCPFOrCNPJ('36641876870')
//=> true

isCPFOrCNPJ('213.198.013-20')
//=> false

isCPFOrCNPJ('2131201872781')
//=> false

isCPFOrCNPJ('11111111111')
//=> false

isCPFOrCNPJ('41142260000189')
//=> true

isCPFOrCNPJ('45.723.174/0001-10')
//=> true

isCPFOrCNPJ('411407182')
//=> false

isCPFOrCNPJ('11.111.111/1111-11')
//=> false

`isDate`

Verifica se é uma data válida e se corresponde ao formato brasileiro.

isDate('03/08/2017')
//=> true

isDate('28/13/2017')
//=> false

isDate('03-08-2017')
//=> false

isDate('31/03/18')
//=> false

`isDDD`

Verifica se é um código DDD (discagem direta à distância) brasileiro válido.

Baseado na resolução nº 263, de 8 de junho de 2001.

isDDD('81')
//=> true

isDDD('10')
//=> false

isDDD('555')
//=> false

`isPhone`

Verifica se está em um formato comum de número de telefone brazileiro, opcionalmente com DDI, DDD e o nono dígito. Se o DDD estiver definido ele será verificado com isDDD.

isPhone('+55 (11) 9 8273-1182')
//=> true

isPhone('11 9 8273 1182')
//=> true

isPhone('1139723768')
//=> true

isPhone('(23) 3972-3768')
//=> false

isPhone('(13) 6 5093-2093')
//=> false

isPhone('(81) 555 178')
//=> false

Contribuindo

Docker

Caso queira rodar em um ambiente isolado(container) você pode usar o docker.

Primeiro construa a imagem em sua maquina

docker build -t brazilian-values:latest .

Após isso rode o ambiente em modo interativo

docker run -it -v ${PWD}:/usr/src/app brazilian-values:latest bash

Você entrara em um container com o ambiente isolado da maquina. rode o yarn install e pode começar a usar todo o projeto`

yarn install

Licença

Lançado sob a licença MIT.

brazilian-values's People

Contributors

Stargazers

Watchers

brazilian-values's Issues

create a parser from list [x, y, z]

This is a kind of disambiguation from a comment in issue #7.

Provide a parser to convert list formatted value into an Array.

'1, 2, 3 e 4' => ['1', '2', '3', '4']
'Vitor, Leonardo, Francisco e Fernando Lima' => ['Vitor', 'Leonardo', 'Francisco', 'Fernando Lima']
'' => []
'1' => ['1']
'1 e 2' => ['1', '2']

Why not use toLocaleString in formatToBRL?

You could use value.toLocaleString('pt-br', { style: 'currency', currency: 'BRL' }).
What do you think about it?
Thanks a lot for this lib 💯

create a list formatter function (x, y e z)

A function to format ArrayLike values into a string using commas and "e" article.

[1, 2, 3, 4] => '1, 2, 3 e 4'
[1, 2] => '1 e 2'
[1] => '1'
[] => ''

Documentação em português

A biblioteca é sobre formatação de documentos, valores e unidades brasileiras, mas o código e a documentação estão em inglês.

A documentação deveria ser em português com a opção do inglês.

Email

Inclui a função de validação de email que ai o pacote fica completo :)

const validaEmail = function (email) {
const re = /^(([^<>()[]\.,;:\s@"]+(.[^<>()[]\.,;:\s@"]+)*)|(".+"))@(([[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}])|(([a-zA-Z-0-9]+.)+[a-zA-Z]{2,}))$/
return re.test(email)
}

Include a new format of cep

In isCep function when I verify with this format ##.###-### it will return me a false, but if I use the same value without the mask it will be ok.
So could you use at the cep pattern an optional '.' and '-'

Prettify masked values [HELP NEEDED] [FEATURE REQUEST]

The problem

By default the non numeric characters are removed from the string.
I need to pretty print masked phones and CEPs. How can I do it?

Possible solution

Example of possible implementation

formatToCEP('15998030')
//=> '15998-030'
 
formatToCEP('****8030', { masked: true })
//=> '****8-030'

formatToPhone('11971626799') 
//=> '(11) 9 7162-6799'

formatToPhone('*******6799', { masked: true })
//=> '(**) * ****-6799'

The new method signature could be as follows:

formatToCEP(value, { masked = false, mask_digit = '*' })
formatToPhone(value, { masked  = false, mask_digit = '*' })

Fix README installation instruction

In the installation guide, I noticed that it's recommending the installation of the package as a development package.

Since it's a dependency that should be available on production, what about changing it?

Suggested change:

npm install brazilian-values --save-dev -> npm install brazilian-values --save

Best regards.

Adicionar função que cheque se é um CNPJ ou CPF válido

É bastante comum encontrar fluxos com um único campo que pode ser usado tanto como CNPJ quanto CPF. Por isso é interessante ter uma função que já cheque se o valor é um CPF ou um CNPJ válido

Junção de projetos

Opa, tudo certinho? Sou um dos criadores da brazilian-utils (https://github.com/brazilian-utils/brazilian-utils) e eu achei muito interessante o teu projeto.

Queria te convidar para fazer parte da nossa organização e incorporar tuas lib a nossa toolkit, o que você acha disso? Contamos hoje com 5 contribuidores ativos e seria incrível te ter como parte dessa equipe 😄

Adicionar um ambiente docker para contribuidores

fiz a PR. Tive um problema com o meu ambiente local, meu node era 8 e o projeto request 12 então criei um amibente no Docker. Posso fazer a PR dele tambem se interresar. Coloquei umas informações no README sobre o docker no branch docker do meu fork

Originally posted by @mandala21 in #28 (comment)

what about handling CPF if zero at left?

example

1004218907

context.true(isCPF('1004218907'));

isCPF says this is an invalid CPF

support brazilian's date time format on parseToDate

Supporting #22 request is something we can't do, but we can provide a better way to handle it by improving parseToDate function.

fix command formatBRL in npm README

Please, fix command in README from npm, you need to publish again with fix.

https://www.npmjs.com/package/brazilian-values#formattobrl

split date de um formato que é padrão em alguns bancos

eu resolvi splitando no meu projeto, mas seria legal fazer esse split por aqui talvez, se quiser eu posso contribuir :), valeuee

segue o formato: '2019-11-27T19:00:00Z'

isPhone not working?

Hi guys, I'm very proud to find a solution so good made by Brazilians.

I'm trying to use the function isPhone but I don't know if I'm using this wrong, but it's not working as well.

When I type a mobile phone starting with 9 the mask works fine but the state not, and the validation not work because of that. 🤔

See this gif and the code working on SandBox.

https://codesandbox.io/s/shy-surf-4bo20

parser from brazilian number formatted value

This is a kind of disambiguation from a comment in issue #6.

Provides a parser to convert brazilian number formatted value into a number.

'1' => 1
'2.000' => 2000
'129.034,138' => 129034.138

Telefones

Muito boa esse lib.
Sugiro uma validação para os telefones também.

`isDatePattern` should be removed

isDatePattern seems useless because I've never had a case to use it and even can't think of one.

It can confuse people instead and should be removed from validators. isDate, which is a real date validator, should be used instead.

Lack of examples of CDN usage

There's no examples or docs about CDN usage and would be nice if we have it.

create a number formatter function (28.187,289)

We use numbers like 28.187,289 in Brazil and there's no function to format into this.

Exports a formatter function to transform numbers and number parseables into this format.

Capitalize

Incoporar uma função de Capitalize, similar ao
https://www.npmjs.com/package/capitalize-pt-br

Vantagem:

Unificação de função no mesmo package

Me disponibilizo a fornecer um pull request

https://codesandbox.io/s/keen-bose-k6y63

Thanks for helping 🙏🏼

CNPJ valida com sucesso mesmo se o conteúdo tiver letras

Ao usar o isCNPJ percebi que mesmo tendo letras junto a um CNPJ válido a validação é feita com sucesso.
ex: 64.637.agsvs009/0001-90 > true

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.

vitorluizc / brazilian-values Goto Github PK

brazilian-values's Introduction

Brazilian Values

Instalação

Instalação por CDN

Como usar

API

Formatação

formatToBRL

formatToCapitalized

formatToCEP

formatToCNPJ

formatToCAEPF

formatToCPF

formatToCPFOrCNPJ

formatToDate

formatToDateTime

formatToList

formatToNumber

formatToPhone

formatToRG

formatToHiddenDigits

Conversores

parseToArray

parseToDate

parseToNumber

Validadores

isCEP

isCNPJ

isCAEPF

isCPF

isCPFOrCNPJ

isDate

isDDD

isPhone

Contribuindo

Docker

Licença

brazilian-values's People

Contributors

Stargazers

Watchers

Forkers

brazilian-values's Issues

The problem

Possible solution

Recommend Projects

Recommend Topics

Recommend Org

`formatToBRL`

`formatToCapitalized`

`formatToCEP`

`formatToCNPJ`

`formatToCAEPF`

`formatToCPF`

`formatToCPFOrCNPJ`

`formatToDate`

`formatToDateTime`

`formatToList`

`formatToNumber`

`formatToPhone`

`formatToRG`

`formatToHiddenDigits`

`parseToArray`

`parseToDate`

`parseToNumber`

`isCEP`

`isCNPJ`

`isCAEPF`

`isCPF`

`isCPFOrCNPJ`

`isDate`

`isDDD`

`isPhone`