standard-payload v1.0.0

standard-payload

Tiny library for creating standard response payloads for Node.js based REST API's.

Installation

npm install --save standard-payload

Usage

const payload = require('standard-payload');

payload.withItem({
  id: 5,
  name: 'Arthur',
});

/**

Returns object.
{
  error: false,
  payload: {
    item: {
      id: 5,
      name: 'Arthur',
    }
  }
}

**/

Api

• payload.withItem(obj) - Send item object.
• payload.withItems(array) - Send array of items with payload
• payload.withMessage(msgString) - Send message string in payload
• payload.withError(errorObj) - Send error item in payload