{"id":22729434,"url":"https://github.com/dmalbuquerque/brazuka-formatter","last_synced_at":"2026-03-05T22:35:21.799Z","repository":{"id":48821751,"uuid":"381768238","full_name":"dmAlbuquerque/brazuka-formatter","owner":"dmAlbuquerque","description":"Este pacote tem o intuito de facilitar a vida dos Devs com a formatação de dados de acordo com o padrão Brasileiro, como CEP, CPF, CNPJ entre outros.","archived":false,"fork":false,"pushed_at":"2021-07-09T22:04:43.000Z","size":135,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-11T16:14:42.598Z","etag":null,"topics":["brasil","brasileiro","brazuka","cep","cnpj","cpf","documentos","formatter","javascript","nodejs"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/brazuka-formatter","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dmAlbuquerque.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-06-30T16:33:57.000Z","updated_at":"2021-07-09T22:04:46.000Z","dependencies_parsed_at":"2022-09-08T09:23:20.632Z","dependency_job_id":null,"html_url":"https://github.com/dmAlbuquerque/brazuka-formatter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmAlbuquerque%2Fbrazuka-formatter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmAlbuquerque%2Fbrazuka-formatter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmAlbuquerque%2Fbrazuka-formatter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmAlbuquerque%2Fbrazuka-formatter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dmAlbuquerque","download_url":"https://codeload.github.com/dmAlbuquerque/brazuka-formatter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248794561,"owners_count":21162614,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["brasil","brasileiro","brazuka","cep","cnpj","cpf","documentos","formatter","javascript","nodejs"],"created_at":"2024-12-10T18:09:55.418Z","updated_at":"2026-03-05T22:35:21.764Z","avatar_url":"https://github.com/dmAlbuquerque.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Funções para formatação de Documentos no padrão BRASILEIRO\n\n[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)\n![Issues](https://img.shields.io/github/issues/dmAlbuquerque/brazuka-formatter)\n[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/tterb/atomic-design-ui/blob/master/LICENSEs)\n[![Open Source Love png3](https://badges.frapsoft.com/os/v3/open-source.png?v=103)](https://github.com/ellerbrock/open-source-badges/)\n\n# Sobre o projeto\nO objetivo do projeto é facilitar a vida dos Devs fornecendo uma biblioteca completa de formatação de documentos no padrão Brasileiro.\n\nConfira abaixo a **Documentação** completa de como **_instalar_**, **_importar_** e **_utilizar_** as funções disponíveis para formatação.\n\n\u003cbr\u003e\n\n# Instalando\n\n```shell\nnpm i brazuka-formatter\n```\nou\n\n```shell\nyarn add brazuka-formatter\n```\n\u003cbr\u003e\n\n# Importando\n\n\n### Exemplo 1 de importação\n- Você pode utilizar uma variável para ter acesso a todas as funções, como o exemplo abaixo:\n```js\n//importando\nvar brazuka = require('brazuka-formatter')\n\n//Exemplo de utilização de uma função\nbrazuka.formatCep(\"12345678\")\n```\n\n### Exemplo 2 de importação\n- Você pode setar apenas as funções que deseja utilizar, como o exemplo abaixo:\n```js\n//Importando apenas duas funções\nconst {formatCep, formatCpf} = require('brazuka-formatter')\n\n//Exemplo de utilização de uma função\nformatCep(\"12345678\")\n```\n\n\u003cbr\u003e\n\n# Utilização dos Métodos\n\n## formatMoney( value, symbol ):\nEssa função irá formatar o dinheiro para o padrão Brasileiro, podendo retornar com o símbolo \"R$\" (através do parâmetro symbol). \n- O parâmetro symbol (opcional), pode ser passado como true ou false. Por padrão é false \n\n```js\n//Exemplo da formatação de Dinheiro\nconst {formatMoney} = require('brazuka-formatter')\n\n//Exemplo 1 - Com o Simbolo R$\nformatMoney(1958.66, true) //result -\u003e R$ 1.958,66\n\n//Exemplo 2 - Sem o Simbolo R$\nformatMoney(1958.66) // result -\u003e 1.958,66\n```\n\n\u003cbr\u003e\n\n## formatCep( value ): \nEssa função vai retornar o CEP no formato 12345-678 \n- O parâmetro value deve ser do tipo string\n\n```js\n//Exemplo da formatação de CEP\nconst {formatCep} = require('brazuka-formatter')\n\nformatCep(\"12345678\") // result -\u003e 12345-678\n```\n\n\u003cbr\u003e\n\n## formatCpf( value ): \nEssa função vai retornar o CPF no formato 123.456.789-09 \n- O parâmetro value deve ser do tipo string\n\n\n```js\n//Exemplo da formatação de CPF\nconst {formatCpf} = require('brazuka-formatter')\n\nformatCpf(\"1234567809\") // result -\u003e 123.456.789-09 \n\n```\n\n\u003cbr\u003e\n\n## formatCnpj( value ): \nEssa função vai retornar o CNPJ no formato 12.345.678/0001-09\n- O parâmetro value deve ser do tipo string\n\n```js\n//Exemplo da formatação de CNPJ\nconst {formatCnpj} = require('brazuka-formatter')\n\nformatCnpj(\"12345678000109\") // result -\u003e 12.345.678/0001-09\n```\n\n\u003cbr\u003e\n\n## formatPisPasep( value ): \nEssa função vai retornar o PIS/PASEP no formato 123.23129.49-1\n- O parâmetro value deve ser do tipo string\n\n```js\n//Exemplo da formatação de PIS/PASEP\nconst {formatPisPasep} = require('brazuka-formatter')\n\nformatPisPasep(\"12323129491\") // result -\u003e 123.23129.49-1\n```\n\n\u003cbr\u003e\n\n## formatTelefone( value ): \nEssa função vai retornar o Telefone no formato (88) 9 1234-4321\n- O parâmetro value deve ser do tipo string\n\n```js\n//Exemplo da formatação de Telefone\nconst {formatTelefone} = require('brazuka-formatter')\n\nformatTelefone(\"88912344321\") // result -\u003e (88) 9 1234-4321\n```\n\n\u003cbr\u003e\n\n## formatInscricaoEstadual( value ): \nEssa função vai retornar a Inscrição Estadual no formato 119.022.490.114\n- O parâmetro value deve ser do tipo string\n\n```js\n//Exemplo da formatação da Inscrição Estadual\nconst {formatInscricaoEstadual} = require('brazuka-formatter')\n\nformatInscricaoEstadual(\"119022490114\") // result -\u003e 119.022.490.114\n```\n\n\u003cbr\u003e\n\n## formatCns( value ): \nEssa função vai retornar a CNS (Carteira Nacional de Saúde - SUS) no formato 119 0224 4902 1144\n- O parâmetro value deve ser do tipo string\n\n```js\n//Exemplo da formatação da CNS\nconst {formatCns} = require('brazuka-formatter')\n\nformatCns(\"119022449021144\") // result -\u003e 119 0224 4902 1144\n```\n\n\u003cbr\u003e\n\n## formatRenavam( value ): \nEssa função vai retornar o Renavam no formato 119 0224 4902 1144\n- O parâmetro value deve ser do tipo string\n\n```js\n//Exemplo da formatação de Renavam\nconst {formatRenavam} = require('brazuka-formatter')\n\nformatRenavam(\"41854498526\") // result -\u003e 4185.449852-6\n```\n\u003cbr\u003e\n\n## formatProcessosJudiciais( value ): \nEssa função vai retornar o Processo Judicial no formato 0042022.68.2021.7.22.1520\n- O parâmetro value deve ser do tipo string\n\n```js\n//Exemplo da formatação de Processos Judiciais\nconst {formatProcessosJudiciais} = require('brazuka-formatter')\n\nformatProcessosJudiciais(\"00420226820217221520\") // result -\u003e 0042022.68.2021.7.22.1520\n```\n\n\u003cbr\u003e\n\n## validateCpf( value ): \nEssa função irá verificar se o CPF informado é válido.\n- O parâmetro value deve ser do tipo string\n\n\n```js\n//Exemplo da formatação de CPF\nconst {validateCpf} = require('brazuka-formatter')\n\nvalidateCpf(\"1234567809\") // result -\u003e false\nvalidateCpf(\"95018158034\") // result -\u003e true\n\n```\n\u003cbr\u003e\n\n## formatHtmlToZap( value ):\nEssa função vai retornar o texto com tags html convertido para tags do WhatsApp\n- O parâmetro value deve ser do tipo string \n\n\u003cbr\u003e\n\n### Conversões de tags disponíveis\n- Negrito: \u003c b \u003e ou \u003c strong \u003e para *\n- Itálico: \u003c i \u003e para _\n- Sublinhado: \u003c u \u003e para ~\n- Monoespaçados: \u003c tt \u003e para ```\n\n```js\nconst {formatHtmlToZap} = require('brazuka-formatter')\n\nvar message = \"\u003ci\u003eEu amo \u003c/i\u003e\u003cb\u003eCafé\u003c/b\u003e\"\nformatHtmlToZap( message ) \n//results _Eu amo_ *Café*\n```\n\n\u003cbr\u003e\n\n## formatReplace( value, search, replace ):\nEssa função vai retornar o texto com a nova substituição de caracteres de acordo com os parâmetros passados.\n- O parâmetro value deve ser do tipo string \n- O parâmetro search pode ser do tipo string ou array\n- O parâmetro replace pode ser do tipo string ou array\n\n\u003cblockquote\u003e\u003cb\u003eObs.:\u003c/b\u003e Caso deseje passar o parâmetro \u003ci\u003esearch\u003c/i\u003e e \u003ci\u003ereplace\u003c/i\u003e como array, os dois parâmetros devem possuir a mesma quantidade de elementos.\u003c/blockquote\u003e\n\n\u003cbr\u003e\n\n### Substituição Simples\n```js\nconst {formatReplace} = require('brazuka-formatter')\n\nvar message = \"Meu nome é João\" //mensagem\nvar search  = \"João\" //valor a ser procurado\nvar replace = \"Daniel\" //novo valor que vai substituir o 'search'\nformatReplace( message, search, replace ) \n//results Meu nome é Daniel\n```\n\n\u003cbr\u003e\n\n### Substituição Multipla\n```js\nconst {formatReplace} = require('brazuka-formatter')\n\nvar message = \"João, Maria e José são programadores e amam chocolate\" //mensagem\nvar search  = [\"João\", \"Maria\", \"José\", \"chocolate\"] //valor a ser procurado\nvar replace = [\"Daniel\", \"Macley\", \"Fernando\", \"café\"] //novo valor que vai substituir o 'search'\nformatReplace( message, search, replace ) \n//results Daniel, Macley e Fernando são programadores e amam café\n```\n\n\u003cbr\u003e\n\n## 🛠️ Em breve 🛠️\nEm breve será adicionado novas funções para complementar o pacote:\n- Data\n- Outros documentos Brasileiros\n\n\u003cbr\u003e\n\n## 🚀 Contribuição\nAs 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**.\n\n\u003cbr\u003e\n\n## ✔️ License\nDistribuido sob a licença [MIT](LICENSE). © Daniel Albuquerque\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdmalbuquerque%2Fbrazuka-formatter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdmalbuquerque%2Fbrazuka-formatter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdmalbuquerque%2Fbrazuka-formatter/lists"}