README

Funções para formatação de Documentos no padrão BRASILEIRO

Issues

Sobre o projeto

O objetivo do projeto é facilitar a vida dos Devs fornecendo uma biblioteca completa de formatação de documentos no padrão Brasileiro.

Confira abaixo a Documentação completa de como instalar, importar e utilizar as funções disponíveis para formatação.

Instalando

npm i brazuka-formatter

yarn add brazuka-formatter

Importando

Exemplo 1 de importação

Você pode utilizar uma variável para ter acesso a todas as funções, como o exemplo abaixo:

//importando
var brazuka = require('brazuka-formatter')

//Exemplo de utilização de uma função
brazuka.formatCep("12345678")

Exemplo 2 de importação

Você pode setar apenas as funções que deseja utilizar, como o exemplo abaixo:

//Importando apenas duas funções
const {formatCep, formatCpf} = require('brazuka-formatter')

//Exemplo de utilização de uma função
formatCep("12345678")

Utilização dos Métodos

formatMoney( value, symbol ):

Essa função irá formatar o dinheiro para o padrão Brasileiro, podendo retornar com o símbolo "Rquot; (através do parâmetro symbol).

O parâmetro symbol (opcional), pode ser passado como true ou false. Por padrão é false

//Exemplo da formatação de Dinheiro
const {formatMoney} = require('brazuka-formatter')

//Exemplo 1 - Com o Simbolo R$
formatMoney(1958.66, true) //result -> R$ 1.958,66

//Exemplo 2 - Sem o Simbolo R$
formatMoney(1958.66) // result -> 1.958,66

formatCep( value ):

Essa função vai retornar o CEP no formato 12345-678

O parâmetro value deve ser do tipo string

//Exemplo da formatação de CEP
const {formatCep} = require('brazuka-formatter')

formatCep("12345678") // result -> 12345-678

formatCpf( value ):

Essa função vai retornar o CPF no formato 123.456.789-09

O parâmetro value deve ser do tipo string

//Exemplo da formatação de CPF
const {formatCpf} = require('brazuka-formatter')

formatCpf("1234567809") // result -> 123.456.789-09

formatCnpj( value ):

Essa função vai retornar o CNPJ no formato 12.345.678/0001-09

O parâmetro value deve ser do tipo string

//Exemplo da formatação de CNPJ
const {formatCnpj} = require('brazuka-formatter')

formatCnpj("12345678000109") // result -> 12.345.678/0001-09

formatPisPasep( value ):

Essa função vai retornar o PIS/PASEP no formato 123.23129.49-1

O parâmetro value deve ser do tipo string

//Exemplo da formatação de PIS/PASEP
const {formatPisPasep} = require('brazuka-formatter')

formatPisPasep("12323129491") // result -> 123.23129.49-1

formatTelefone( value ):

Essa função vai retornar o Telefone no formato (88) 9 1234-4321

O parâmetro value deve ser do tipo string

//Exemplo da formatação de Telefone
const {formatTelefone} = require('brazuka-formatter')

formatTelefone("88912344321") // result -> (88) 9 1234-4321

formatInscricaoEstadual( value ):

Essa função vai retornar a Inscrição Estadual no formato 119.022.490.114

O parâmetro value deve ser do tipo string

//Exemplo da formatação da Inscrição Estadual
const {formatInscricaoEstadual} = require('brazuka-formatter')

formatInscricaoEstadual("119022490114") // result -> 119.022.490.114

formatCns( value ):

Essa função vai retornar a CNS (Carteira Nacional de Saúde - SUS) no formato 119 0224 4902 1144

O parâmetro value deve ser do tipo string

//Exemplo da formatação da CNS
const {formatCns} = require('brazuka-formatter')

formatCns("119022449021144") // result -> 119 0224 4902 1144

formatRenavam( value ):

Essa função vai retornar o Renavam no formato 119 0224 4902 1144

O parâmetro value deve ser do tipo string

//Exemplo da formatação de Renavam
const {formatRenavam} = require('brazuka-formatter')

formatRenavam("41854498526") // result -> 4185.449852-6

formatProcessosJudiciais( value ):

Essa função vai retornar o Processo Judicial no formato 0042022.68.2021.7.22.1520

O parâmetro value deve ser do tipo string

//Exemplo da formatação de Processos Judiciais
const {formatProcessosJudiciais} = require('brazuka-formatter')

formatProcessosJudiciais("00420226820217221520") // result -> 0042022.68.2021.7.22.1520

formatHtmlToZap( value ):

Essa função vai retornar o texto com tags html convertido para tags do WhatsApp

O parâmetro value deve ser do tipo string

Conversões de tags disponíveis

Negrito: < b > ou < strong > para *
Itálico: < i > para _
Sublinhado: < u > para ~
Monoespaçados: < tt > para ```

const {formatHtmlToZap} = require('brazuka-formatter')

var message = "<i>Eu amo </i><b>Café</b>"
formatHtmlToZap( message ) 
//results _Eu amo_ *Café*

formatReplace( value, search, replace ):

Essa função vai retornar o texto com a nova substituição de caracteres de acordo com os parâmetros passados.

O parâmetro value deve ser do tipo string
O parâmetro search pode ser do tipo string ou array
O parâmetro replace pode ser do tipo string ou array

Obs.: Caso deseje passar o parâmetro search e replace como array, os dois parâmetros devem possuir a mesma quantidade de elementos.

Substituição Simples

const {formatReplace} = require('brazuka-formatter')

var message = "Meu nome é João" //mensagem
var search  = "João" //valor a ser procurado
var replace = "Daniel" //novo valor que vai substituir o 'search'
formatReplace( message, search, replace ) 
//results Meu nome é Daniel

Substituição Multipla

const {formatReplace} = require('brazuka-formatter')

var message = "João, Maria e José são programadores e amam chocolate" //mensagem
var search  = ["João", "Maria", "José", "chocolate"] //valor a ser procurado
var replace = ["Daniel", "Macley", "Fernando", "café"] //novo valor que vai substituir o 'search'
formatReplace( message, search, replace ) 
//results Daniel, Macley e Fernando são programadores e amam café

🛠️ Em breve 🛠️

Em breve será adicionado novas funções para complementar o pacote:

Data
Outros documentos Brasileiros

🚀 Contribuição

As contribuições tornam a comunidade de código aberto um lugar incrível para aprender, inspirar e criar. Qualquer contribuição que você fizer será muito bem-vinda.

brazuka-formatter

Usage no npm install needed!