Resp Express

Intro

Resp Express foi a minha primeira Library publicada no npmjs, eu já vinha utilizando-a há algum tempo nos projetos privados e decidi que publicá-la para facilitação.
Trata-se de um simples encapsulamento do método de resposta da library “ExpressJS”, vamos lá!

Motivation

A principal motivação para publicação dessa library foi o “Laboratório”, como pesquisador e desenvolvedor eu estou sempre construindo laboratórios para compreender determinados conceitos, nesse sentido, criei essa library para aprender como publicar uma library, com atender determinados requisitos para que a mesma pudesse funcionar em diferentes padrões JS e Typescript.

The Library

A library, hoje, encapsula 7 variações de respostas, sendo elas;

• returnSucessMessage
• returnSucessObject
• returnErrorMessage
• returnErrorObject
• returnObjectWithCode
• returnErrorCode
• returnSucessCode

Segue abaixo alguns exemplos de uso.

Install

npm install resp-express
# or
yarn add resp-express

Import

import resp from "resp-express";
// or
const resp = require("resp-express").default;

Use

app.get("/", function(req, res) {
  resp.returnSucessMessage(res, "Sucess !!");
});

Ao digitar “resp.”, aparecerá todos os métodos, semanticamente, iniciando com a palavra “return”, por exemplo; “returnSucessMessage”.
No exemplo, “returnSucessMessage”, ele aceita 2 parâmetros, sendo eles;

• res; o Object “Response” do express.
• message; uma String que será enviada como resultado da Request.

Um exemplo do objeto que será retornado;

{
  "ok": "Sucess !!"
}

Seguindo essa lógica, alguns métodos vão ter a key “ok” ou “error” implicíto, fazendo necessário passar apenas o conteúdo, outros métodos como “returnSucessObject”, necessitará do object que será retornado, não possuirá a key “ok” implícita, outros método como “returnErrorMessage”, retornará sempre um objeto e conterá sempre o status 400.

Para fazer retornos fora desses padrões, eu escrevi os métodos “returnObjectWithCode”, que aceita Status Code e Object como parâmetros, podendo ser usado para retornar Sucess ou Error Response.
Os métodos “returnSucessCode” e “returnErrorCode” tem funcionalidade parecida, eles também aceitam Status e Object como parâmetros, devendo ser usado respectivamente para retornar “Sucess” ou “Error”.