Skip to content

gh-conf/gh-conf-response

Repository files navigation

gh-conf-response

Build NPM Version NPM Downloads Github Repo Size LICENSE Contributors Commit

Response builder for gh-conf libraries

Give us a ⭐ if you like our work ❤️

Install

$ npm install @gh-conf/gh-conf-response

Usage

const { formatError, formatSuccess } = require("@gh-conf/gh-conf-response");

const successResponse = formatSuccess("Successfully passed", {
  name: "formatSuccess",
});
console.log(successResponse);
// Output
/**
 * {
 *  status: 'success',
 *  message: 'Successfully passed',
 *  data: {
 *    name: 'formatSuccess'
 *  }
 * }
 **/

const errorResposne = formatError("Error running tests", { err: "101" });
console.log(successResponse);
// Output
/**
 * {
 *  status: 'err',
 *  message: 'Error running tests',
 *  data: {
 *    err: '101'
 *  }
 * }
 **/

Contributing

Interested in contributing to this project? You can log any issues or suggestion related to this library here

Read our contributing guide on getting started with contributing to the codebase