Wondering what’s next for npm?Check out our public roadmap! »

    rastrearpedidos

    1.0.0 • Public • Published

    :package: RastrearPedidos

    📦 RastrearPedidos

    Serviço de rastreamento de objetos integrado aos serviços dos Correios

    Gostou o projeto? Por favor considere uma doação para ajudar a melhorar!

    Rastreamento de objetos integrado aos serviços dos Correios

    Faça rastreio de objetos do correio usando o módulo rastrearpedidos, ele utiliza WebScraping para coletar os dados do endpoint dos correios e retorna isso numa promise javascript

    Features

    • ES6/ESNext - Usado código ES6 e Babel pra transpilar isso pra ES5 ou outras versões mais antigas;
    • Testes - Mocha with Istanbul coverage
    • Lint - Pré-configurado ESlint com configuração Airbnb
    • CI - Suporte ao TravisCI.
    • Minify - O código depois do build será minificado para desempenho

    Comandos

    • npm run clean - Remove o diretório lib/
    • npm test - Executa testes com resultados de linting e coverage.
    • npm test:only - Executa testes sem linting ou coverage.
    • npm test:watch - Você pode até executar novamente os testes em hotreload!
    • npm test:prod - Execute testes com código minificado.
    • npm run test:examples - Teste exemplos escritos em JS puro para entender melhor o uso do módulo.
    • npm run lint - Roda o ESlint com airbnb-config
    • npm run cover - Obtenha um report de coverage do código
    • npm run build - Babel vai transpilar ES6 => ES5 e minificar o código.
    • npm run prepublish - Hook para npm. Vai fazer todas as verificações antes de publicar seu módulo.

    Instalação

    pra instalar o módulo em seu projeto basta rodar o comando abaixo:

    npm i rastrearpedidos

    Agora em seu projeto basta importar o módulo dessa forma:

    const rastreio = require("rastrearpedidos");

    Ou pode usar o import:

    import rastreio from "rastrearpedidos";

    Uso

    Pra usar em seu projeto node importe e chame o rastreio passando o código de rastreio como parâmetro e lembre-se que ele é uma promisse que precisa ser resolvida.

    const rastreio = require("rastrearpedidos");
    rastreio("LB498113226SE").then(console.log);

    Assim irá retornar uma Array de objetos mostrando o andamento do pedido com o seguinte formato:

    [
      {
        "data": "07/04/2021",
        "dataHora": "07/04/2021 14:00",
        "descricao": "Objeto postado",
        "cidade": "Arraias",
        "uf": "TO"
      }
    ]

    🐛 Issues

    Sinta-se à vontade para mandar um novo issue com o respectivo título e descrição no repo rastrearpedidos. Se você já encontrou uma solução para o seu problema, eu adoraria revisar sua solicitação de pull!

    📕 Licença

    Feito com amor por Hebert F. Barros 🚀. Esse projeto está sob Licença MIT.

    Dê uma ⭐️ se esse projeto ajudou você...

    Install

    npm i rastrearpedidos

    DownloadsWeekly Downloads

    2

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    13.8 kB

    Total Files

    13

    Last publish

    Collaborators

    • avatar