express-standard-http-responses v2.2.0

Foreword

Hi 👋 !
This package has the only purpose to format the responses for express.

Installation

npm install express-standard-http-responses --save

Environment used

npm@8.5.1
node@14.16.0

Example

import {httpResponses} from "express-standard-http-responses";
import * as express from 'express';

const app = express();
const port = process.env.port || 3000;

app.listen(port, () => {
    console.log(`Listening at http://localhost:${port}`)
});

app.get('/test', (req, res) => {
    return httpResponses(res).body({body: {nested: "content"}}).message('Information').created();
});

Response example

{
  "body": {
    "nested": "content"
  },
  "message": "Information"
}

Headers

You can set headers manually or through middlewares

app.get('/test', (req, res) => {
    res.header('Authorization', 'test');
    return httpResponses(res).body({body: {nested: "content"}}).message('Information').created();
});

Methods

Setting a body

httpResponses(res).body({test: 'body'});

Setting a message

httpResponses(res).message('This is an example.');

Codes 2xx

Codes 3xx

Codes 4xx

Codes 5xx