npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

restponse

v0.1.1

Published

Easy RESTful JSON responses for cleaner API development.

Downloads

3

Readme

RESTponse

A simple library that makes it extremely simple to streamline API responses.


Install the package with

npm i -s restponse

or use it with Yarn

yarn add restponse

This package has 0 dependencies (excluding devDependencies used for testing and coverage), and leverages the built in Node JS http module to provide status codes. Refer to said module to see what status codes you can include in your app.

Usage example (with Express):

const Restponse = require('restponse')
const restponse = new Restponse()

app.get('/', (req, res) => {
  res.send(restponse[200])
})

The endpoint will respond with the following:

{
  "status": "200",
  "reason": "OK"
}

Extending with more options:

To add a new key and value pair to the generated JSON, you can just add it to the config object, which is a parameter of the constructor.

In this example we'll add version and name information:

const restponse = Restponse({
  version: '1.2',
  name: 'MyAPI'
})

The response to the previous request will now be:

{
  "status": "200",
  "reason": "OK",
  "name": "MyAPI",
  "version": "1.2"
}

The type of the value for these can also be a number or a string, which will behave the same way, however if you provide a function, it will take the options object as the parameter and the returned value will be passed into the returned object.

const restponse = new Restponse({
  url: function ({status, version}) {
    return `https://mywebsite.com/api/${version}/status/${status}`
  },
  version: '1.2'
})

The response to this request will now be:

{
  "status": "200",
  "reason": "OK",
  "version": "1.2",
  "url": "https://mywebsite.com/api/1.2/status/200"
}

This feature is particularly useful if you want developers to have quick access to more information about your responses.

Finally if you want to add fields that only apply to specific statuses, you can do so by giving an object that has the specific key for the request.

It is advised to provide at least an empty string to all the status codes.

const restponse = new Restponse({
  message: {
    200: 'This means everything is fine.'
  }
})

Response:

{
  "status": "200",
  "reason": "OK",
  "message": "This means everything is fine."
}

If you want to add objects (like arrays) to your response, you can do so after intialization. To add payload to the response, you can just add it as a property:

app.get('/', (req, res) => {
  let response = Object.assign({}, restponse[200])
  response.payload = 'Welcome to index.'
  res.send(response)
})

Contributing

Feel free to add PRs.