@itemsjs/restful-api-response v1.0.0

Restful API responses

Standardize your API responses using these three response types. 1. Empty 2. Single 3. Multiple

Cover errors, code, pagination and meta fields.

Installation

npm i @itemsjs/restful-api-response --save

Usage

const responses = require('@itemsjs/restful-api-response');

// Assume that you're handling a request inside any web framework request handler

// Express

(req, res, next) => {

    const singleResponse = new responses.Single(
        err,                    // any occured error
        result,                 // operation result
        'DONE',                 // Simple human-readable code
        {                       // any metadata object
            responseTime: 10,   
            delay: 5
        }
    );
};

And you're good to go!

License

MIT