handleresponses v1.0.0

Middelware designed with the most common answers

JavaScript

Autor: Sirtori Gustavo

Install

npm install express-handle-responses-js

Use

const handleResponses = require('mi-paquete-respuestas');

// Example usage:
const app = express();

app.use(handleResponses);

app.get('/', (req, res) => {
  res.sendSuccess({ message: "Hello world!" });
});

app.listen(3000);

Methods (default payload = null)

res.sendSuccess(payload, message)

Return a 200 Successful response where:

  {
    "statusCode": 200,
    "isError": false,
    "message": "Success", //Deault Message
    "payload": { data }
}

res.sendCreated(payload, message)

Return 201 Successful creation response

  {
    "statusCode": 201,
    "isError": false,
    "message": "Created", //Deault Message
    "payload": { data }
}

res.sendNoContent(message, payload)

Return 204 With no content

  {
    "statusCode": 201,
    "isError": false,
    "message": "No content", //Deault Message
    "payload": null
}

res.sendUserError(message, payload)

Return 400 User error

  {
    "statusCode": 400,
    "isError": true,
    "message": "Bad Request", //Deault Message
    "payload": { data }
}

res.sendUserUnAuthorized(message, payload)

Return 401 User unauthorized

  {
    "statusCode": 401,
    "isError": true,
    "message": "Unauthorized", //Deault Message
    "payload": { data }
}

res.sendUserForbidden(message, payload):

Return 403 User forbidden

  {
    "statusCode": 403,
    "isError": true,
    "message": "Forbidden", //Deault Message
    "payload": { data }
}

res.sendNotFound(message, payload)

Return 404 Not found

  {
    "statusCode": 404,
    "isError": true,
    "message": "Not Found", //Deault Message
    "payload": { data }
}

res.sendServerError(message, payload)

Return 500 Server error

  {
    "statusCode": 500,
    "isError": true,
    "message": "Internal Server Error", //Deault Message
    "payload": { data }
}

Additional features

res.tokenCookie(token)

Sets a cookie with the authentication token.

Code: res.cookie('token', token, cookiesoptions);

Cookie Optiens:

const cookiesoptions = {
  maxAge: (1000*60*60*24),
  httpOnly: true
}

res.sendTokenCookieSuccess(token, payload)

Sends a successful response with code 200 and sets a cookie with the authentication token.

res.sendSuccessOrNotFound(variable, title)

Sends a success response if the variable exists, or a not found response otherwise.

• Default error message: "${title} not found"

res.sendCatchError(error, message)

Sends a server error response with code 500 and the specified error message.

This code: --> res.sendServerError(message, error.toString())

License

This package is licensed under the MIT License.