kron v1.0.30

Framework Kron

Kron

Como utilizar o módulo Kron.

import { Kron } from 'kron';
const kron = new Kron(); 

const middleware = ({ request, response, next }) => {
    return next;
}

kron.route({
    method: 'GET',
    path: '/',
    handler: ({ response }) => {
        return response.status(203).json({ tudo: "certo" });
    }
});

kron.listen(3000); // Inicia o server, conter apenas um em todo sistema

Métodos.

Kron

O módulo kron ao ser importado, ele deverá ser instanciado, deverá conter apenas uma instância do kron, onde será o ponto de entrada. Para inciar o servidor deve-se no final usar o server.listen(3000);

import { kron } from 'kron';
const kron = new Kron();

kron.route({
    method: 'GET',
    path: '/',
    handler: ({ response }) => {
        return response.status(203).json({ tudo: "/Cliente" });
    }
});

kron.listen(3000);

Rotas

O kron tem um sistema de rotas, bem elegante, com ele você pode criar suas rotas muito facilmente. Segue abaixo o modo de criar novas rotas, deverá ser importado do módulo kron, deverá ser criado uma nova instância. Com isso já poderá ser criado novas rotas.

import { kron } from 'kron';
const kron = new Kron();

Como criar novas rotas.

import { kron } from 'kron';
const kron = new Kron();

kron.route({
    method: 'GET',
    path: '/',
    handler: ({ response }) => {
        return response.status(203).json({ tudo: "/Cliente" });
    }
});

kron.listen(3000);

A sintaxe de se trabalhar com rotas no kron, e bem simples deve apenas passar um objeto, que terá as seguinte propriedades.

Exemplo de rota.

{
    method:"GET",
    path:"/",
    middleware:[], // Opcional
    handler:({ response, request, next }) {
    
    }
}

Explicação dos campos da estrutura da rota.

• method: Nesse atributo, deverá ser adicionado o método HTTP em upperCase.

• path: Nesse atributo, deverá ser adicionado o path.

• middleware : Esse atributo e o único que não é obrigatório, nele será passado um array de middlewares, que será executado antes do método handler, caso queira apenas validar alguns dados, é caso esteja tudo certo ele vá para método handler, deverá ser retornado o next, propriedade que terá acesso pela desestruturação dos argumentos, e caso queira que o próprio middleware realiza a resposta para o solicitante, e que não chegue no handler, será preciso apenas realizar a resposta normalmente.

  return response.send("Método parou no middleware")

const middleware = ({ request, response, next }) => {
    return response.send("Método parou no middleware")
}
kron.route({
    method: 'GET',
    path: '/',
    middleware: [middleware],
    handler: ({ response }) => {
        return response.status(203).json({ tudo: "/Cliente" });
    }
});

• Handler: O método handler e um dos mais importantes, e que acredito, o que mais você vai utilizar, nele é onde irá ficar a resposta da sua rota. Os argumentos que ela recebe, pode ser acessados usando desestruturação, onde irá retornar os argumentos { request, response, next }. Nele deverá ser retornado uma resposta, caso não seja retornado next o kron irá retornar uma mensagem default que não houve resposta.

{ request, response, next }.

Métodos requests

• request.body: Utilizando esse método, terá acesso ao corpo da request em formato JSON

const { nome } = request.body;
console.log(body) // value = "Matheus"

• request.params: Utilizando esse método, terá acessa aos parâmetros passados na url das rotas

const { nome } = request.params;
console.log(body) // value = "Matheus"

Métodos response

• response.status(200): Utilizando esse método, você conseguirá setar o status code de resposta.

response.status(200).send("tudo certo");

• response.json(): Faz com que a resposta,seja retornada em formato JSON.

response.status(200).json({retorno:"retorno"});

• response.send(): Faz com que as resposta, seja retornada em formato de texto.

response.status(200).send("Tudo certo");

• response.ContentType(): Faz com que o que a pessoa, especifique o content type da resposta.

response.status(200).ContentType(
    {
    'Content-Type': 'text/plain',
    'Cache-Control': 'max-age=3600' 
    }
);