express-api-formatter

Adds formatting functions to response


Keywords
express, json, api
License
MIT
Install
npm install express-api-formatter@0.1.0

Documentation

express-api-formatter

Add success and error functions response object in express.

Usage

const express = require('express');
const formatter = require('@spt-identity/express-api-formatter');

const app = express();
app.use(formatter());
app.get('/', (req, res, next) => res.api.success(200, { status: 'ok'}));

API

api.success: (code = 200, data = {})

Sample response

{
    "data": {
        "id": 1,
        "title": "my object"
    }
}

api.error: (code = 400, type = '', description = '')

Sample response

{
    "error": {
        "code": 400,
        "type": "something broken",
        "description": "you broke something"
    }
}