marcelocmenezes/rastrojs

Uma biblioteca JavaScript para rastreamento de encomendas nos Correios.

RastroJS

Uma biblioteca JavaScript para rastreamento de encomendas nos Correios.

• RastroJS
  • Instalação
  • Exemplos
    • Básico
    • Com TypeScript
  • Contribuição
  • Licença

Instalação

npm install --save rastrojs

Exemplos

Exemplo Básico

const { rastro } = require('rastrojs');

async function example() {

    const track = await rastro.track('JT124720455BR');

    console.log(track);

};

example();

Exemplo com TypeScript

Certifique-se de incluir "rastrojs" em "types" no tsconfig.json

import { RastroJS, Tracking } from 'rastrojs';

class Example extends RastroJS {

    constructor(private codes: string[]) {
        super();
    }

    public get tracks(): Promise<Tracking[]> {
        return this.track(this.codes)
    }

}

const example = new Example(['JT124720455BR', 'JT124720455BC', '123']);

example
    .tracks
    .then(tracks => console.log(tracks));

Contribuição

Veja como em: CONTRIBUTING.md

Qualquer dúvida ou sugestão: tales.ferreira.luna@gmail.com

Licença

RastroJS é totalmente aberta e está sob licença MIT, use a vontade.