{"_id":"@eduardocalazansjr/cep-promise","name":"@eduardocalazansjr/cep-promise","dist-tags":{"latest":"4.3.3"},"versions":{"4.3.3":{"name":"@eduardocalazansjr/cep-promise","version":"4.3.3","description":"Busca por CEP integrado diretamente aos serviços dos Correios e ViaCEP","main":"dist/cep-promise.min.js","module":"dist/cep-promise.min.js","types":"./index.d.ts","scripts":{"dev":"nodemon --watch src/ --exec \"npm run build\"","test":"npm run coverage","coverage":"babel-node node_modules/.bin/babel-istanbul cover _mocha -- test/**/*.spec.js","test-unit":"mocha test/unit/**/*.spec.js","test-unit-watch":"mocha --watch test/unit/**/*.spec.js","test-e2e":"mocha test/e2e/**/*.spec.js","test-e2e-watch":"mocha --watch test/e2e/**/*.spec.js","lint-check":"standard","lint-fix":"standard --fix","build-browser":"rollup -c && uglifyjs dist/cep-promise-browser.js -cm -o dist/cep-promise-browser.min.js","build-node":"rollup -c && uglifyjs dist/cep-promise.js -cm -o dist/cep-promise.min.js","build":"npm run build-browser && npm run build-node","prepublishOnly":"npm run build"},"browser":"dist/cep-promise-browser.min.js","repository":{"type":"git","url":"git+https://github.com/BrasilAPI/cep-promise.git"},"author":{"name":"Filipe Deschamps"},"license":"MIT","bugs":{"url":"https://github.com/BrasilAPI/cep-promise/issues"},"keywords":["cep","correios","zipcode","zip","promise","viacep","brasilapi","widenet","apicep"],"homepage":"https://github.com/BrasilAPI/cep-promise","devDependencies":{"@babel/cli":"7.10.5","@babel/core":"7.11.1","@babel/node":"7.10.5","@babel/plugin-transform-runtime":"^7.11.0","@babel/preset-env":"7.11.0","@babel/register":"7.10.5","babel-core":"7.0.0-bridge.0","babel-eslint":"10.1.0","babel-istanbul":"0.12.2","chai":"4.2.0","chai-as-promised":"7.1.1","chai-subset":"1.6.0","mocha":"8.1.1","nock":"13.0.2","nodemon":"2.0.4","rollup":"2.20.0","rollup-plugin-babel":"4.4.0","rollup-plugin-commonjs":"10.1.0","rollup-plugin-node-resolve":"5.2.0","rollup-plugin-replace":"2.2.0","standard":"14.3.4","uglify-js":"3.10.0"},"standard":{"parser":"babel-eslint","globals":["describe","it","afterEach"]},"dependencies":{"node-fetch":"2.6.7","unfetch":"4.1.0"},"gitHead":"7e66c1006f0bb46758291dd34fbe4487303b7307","_id":"@eduardocalazansjr/cep-promise@4.3.3","_nodeVersion":"16.16.0","_npmVersion":"8.11.0","dist":{"integrity":"sha512-r5wnvhYExtuSTvgjsox0NGyDU34Ob6UFjDszO/0W8lfO5STuYFwyoeEHPYd/a23o/RpBZ4iClh9B/VTwKvwgOw==","shasum":"0eee01652bed6cb405c52844f53e3e8a46f693d2","tarball":"https://registry.npmjs.org/@eduardocalazansjr/cep-promise/-/cep-promise-4.3.3.tgz","fileCount":8,"unpackedSize":79063,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC+niEwnY3ABZuHB0W7V6TEdUVAl26l64n297/XbNxJqQIgYIEBJ+nmXpGbgeM4bfu5jra8W+7xdWyyn+/jeugJNgU="}]},"_npmUser":{"name":"eduardocalazansjr","email":"eduardoc_jr@me.com"},"directories":{},"maintainers":[{"name":"eduardocalazansjr","email":"eduardoc_jr@me.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cep-promise_4.3.3_1698503016757_0.4484855379184034"},"_hasShrinkwrap":false}},"time":{"created":"2023-10-28T14:23:36.679Z","4.3.3":"2023-10-28T14:23:36.990Z","modified":"2023-10-28T14:23:37.264Z"},"maintainers":[{"name":"eduardocalazansjr","email":"eduardoc_jr@me.com"}],"description":"Busca por CEP integrado diretamente aos serviços dos Correios e ViaCEP","homepage":"https://github.com/BrasilAPI/cep-promise","keywords":["cep","correios","zipcode","zip","promise","viacep","brasilapi","widenet","apicep"],"repository":{"type":"git","url":"git+https://github.com/BrasilAPI/cep-promise.git"},"author":{"name":"Filipe Deschamps"},"bugs":{"url":"https://github.com/BrasilAPI/cep-promise/issues"},"license":"MIT","readme":"<p align=\"center\">\n  <img src=\"http://piskel-imgstore-b.appspot.com/img/d580e96e-bd8a-11e6-b157-9949cad4d609.gif\">\n</p>\n\n<h1 align=\"center\">CEP Promise</h1>\n\n<p align=\"center\">\n  <a href=\"https://npm-stat.com/charts.html?package=cep-promise\">\n    <img src=\"https://img.shields.io/npm/dm/cep-promise.svg\">\n  </a>\n  <a href=\"https://coveralls.io/github/BrasilAPI/cep-promise?branch=master\">\n    <img src=\"https://coveralls.io/repos/github/BrasilAPI/cep-promise/badge.svg?branch=master\">\n  </a>\n  <a href=\"https://www.npmjs.com/package/cep-promise\">\n    <img src=\"https://badge.fury.io/js/cep-promise.svg\">\n  </a>\n  <a href=\"http://standardjs.com/\">\n    <img src=\"https://img.shields.io/badge/code%20style-standard-brightgreen.svg\">\n  </a>\n  <a href=\"https://snyk.io/test/github/BrasilAPI/cep-promise\">\n    <img src=\"https://snyk.io/test/github/BrasilAPI/cep-promise/badge.svg\" alt=\"Known Vulnerabilities\" data-canonical-src=\"https://snyk.io/test/github/BrasilAPI/cep-promise\" style=\"max-width:100%;\">\n  </a>\n</p>\n\n<p align=\"center\">\n  Busca por CEP integrado diretamente aos serviços dos Correios, ViaCEP e WideNet (Node.js e Browser)\n</p>\n\n## Features\n\n * Sempre atualizado em tempo-real por se conectar diretamente aos serviços dos Correios, ViaCEP e WideNet.\n * Possui alta disponibilidade por usar vários serviços como fallback.\n * Sempre retorna a resposta mais rápida por fazer as consultas de forma concorrente.\n * Sem limites de uso (rate limits) conhecidos.\n * Interface de Promise extremamente simples.\n * Suporte ao Node.js `10.x`, `11.x`, `12.x`, `13.x`, `14.x` e `@stable`.\n * Suporte ao Node.js `4.x`, `5.x`, `6.x`, `7.x`, `8.x`, `9.x`, até cep-promise versão `3.0.9`.\n * Suporte ao Node.js `0.10.x` e `0.12.x` até cep-promise versão `2.0.8`.\n * 100% de code coverage com testes unitários e E2E.\n * Desenvolvido utilizando ES6.\n\n\n## Como utilizar\n\nTeste e aprenda <a href=\"https://npm.runkit.com/cep-promise\" target=\"_blank\">aqui</a>.\n\n### Realizando uma consulta\n\nPor ser multifornecedor, a biblioteca irá resolver a Promise com o fornecedor que **mais rápido** lhe responder.\n\n``` js\nimport cep from 'cep-promise'\n\ncep('05010000')\n  .then(console.log)\n\n  // {\n  //   \"cep\":  \"05010000\",\n  //   \"state\":  \"SP\",\n  //   \"city\":  \"São Paulo\",\n  //   \"street\":  \"Rua Caiubí\",\n  //   \"neighborhood\":  \"Perdizes\",\n  // }\n```\n\n\n### Você também poderá passar o CEP como Inteiro\n\nEm muitos sistemas o CEP é utilizado erroneamente como um Inteiro (e com isto cortando todos os zeros à esquerda). Caso este seja o seu caso, não há problema, pois a biblioteca irá preencher os caracteres faltantes na String, por exemplo:\n\n``` js\nimport cep from 'cep-promise'\n\n// enviando sem ter um zero à esquerda do CEP \"05010000\"\ncep(5010000)\n  .then(console.log)\n\n  // {\n  //   \"cep\":  \"05010000\",\n  //   \"state\":  \"SP\",\n  //   \"city\":  \"São Paulo\",\n  //   \"street\":  \"Rua Caiubí\",\n  //   \"neighborhood\":  \"Perdizes\",\n  // }\n```\n\n### Quando o CEP não é encontrado\n\nNeste caso será retornado um `\"service_error\"` e por ser multifornecedor, a biblioteca irá rejeitar a Promise apenas quando tiver a resposta negativa de todos os fornecedores.\n\n``` js\nimport cep from 'cep-promise'\n\ncep('99999999')\n  .catch(console.log)\n\n  // {\n  //     name: 'CepPromiseError',\n  //     message: 'Todos os serviços de CEP retornaram erro.',\n  //     type: 'service_error',\n  //     errors: [{\n  //       message: 'CEP NAO ENCONTRADO',\n  //       service: 'correios'\n  //     }, {\n  //       message: 'CEP não encontrado na base do ViaCEP.',\n  //       service: 'viacep'\n  //     }]\n  // }\n\n```\n\n### Quando o CEP possui um formato inválido\n\nNeste caso será retornado um `\"validation_error\"` e a biblioteca irá rejeitar imediatamente a Promise, sem chegar a consultar nenhum fornecedor.\n\n``` js\nimport cep from 'cep-promise'\n\ncep('123456789123456789')\n  .catch(console.log)\n\n  // {\n  //     name: 'CepPromiseError',\n  //     message: 'CEP deve conter exatamente 8 caracteres.',\n  //     type: 'validation_error',\n  //     errors: [{\n  //       message: 'CEP informado possui mais do que 8 caracteres.',\n  //       service: 'cep_validation'\n  //     }]\n  // }\n```\n### Options\n- `timeout`: Timeout em milisegundos das consultas em cada serviço. O tempo total poderá ser maior devido a limites no paralelismo.\n- `providers`: Lista de providers a serem usados na consulta. Default é usar todos os providers disponíveis.\n\n```js\nimport cep from 'cep-promise'\ncep('5010000', { timeout: 5000, providers: ['brasilapi'] })\n  .then(console.log)\n\n```\n\n### Instalação\n\n#### Browser usando CDN\n```\n<script src=\"https://cdn.jsdelivr.net/npm/cep-promise/dist/cep-promise.min.js\"></script>\n```\n\n#### npm\n\n```\n$ npm install --save cep-promise\n```\n\n#### Bower\n\n```\n$ bower install --save cep-promise\n```\n#### yarn\n\n```\n$ yarn add cep-promise\n```\n\n#### Angular 2\n\n``` ts\nimport * as cep from 'cep-promise'\n\ncep('05010000')\n  .then(console.log)\n```\n\n## Como contribuir\n\nLeia nosso guia de contribuição [aqui](CONTRIBUTING.md)\n\n## Contribuidores\n\n<a href=\"https://github.com/brasilapi/cep-promise/graphs/contributors\"><img src=\"https://contrib.rocks/image?repo=brasilapi/cep-promise\" /></a>\n\n## Autor\n\n| [<img src=\"https://avatars0.githubusercontent.com/u/4248081?v=3&s=115\"><br><sub>@filipedeschamps</sub>](https://github.com/filipedeschamps) |\n| :---: |","readmeFilename":"README.md"}