CpdnCristiano / rastrojs

Uma biblioteca JavaScript para rastreamento de encomendas nos Correios.

RastroJS

Uma biblioteca JavaScript para rastreamento de encomendas nos Correios.

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

Instalação

npm install --save rastrojs

Exemplos

Exemplo Básico

const rastrojs = require('rastrojs');

async function example() {

    const tracks = await rastrojs.track('JT124720455BR', 'NOT-CODE', 'AA124720455US');

    console.log(tracks);

};

example();

Exemplo com TypeScript

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

import rastrojs, { RastroJS, Tracking } from 'rastrojs';


// Funções
async function getObjects() {

    const tracks1 = await rastrojs.track('JT124720455BR');
    const tracks2 = await rastrojs.track(['JT124720455BR', '123']);
    const tracks3 = await rastrojs.track('JT124720455BR', 'JT124720455BC', '123');

    console.log(tracks1, tracks2, tracks3);

}

getObjects();


// Classes
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: [e-mail]

Licença

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