Giter Club home page Giter Club logo

default-response's Introduction

Build Status Coverage Status npm version

Default Response

Simple API "default message" module for use with RESTful APIs.

Installation

$ npm i default-response

Basic Usage

Include the dependency and call response.status(code):

// include default response
const response = require('default-response');

// set a status
console.log(response.status(404));

Logs:

{
  "status": 404,
  "message": "Not found",
  "developerMessage": "The requested resource could not be found but may be available in the future. Subsequent requests by the client are permissible.",
  "error": "ClientError"
}

And many, many more...

Custom Developer Messages

// include default response
const response = require('default-response');

// set a status
console.log(
  response.statusMessage(
    401, 
    "You do not have permission to access the users resource."
  )
);

Logs:

{
  "status": 401,
  "message": "Unauthorized",
  "developerMessage": "You do not have permission to access the users resource.",
  "error": "ClientError"
}

default-response's People

Contributors

codyjdalton avatar

Watchers

 avatar

Forkers

cs-digital

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.