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

jsonapi-formatter

v0.1.2

Published

ES6 Component that works as an omnirouter middleware to provide jsonapi responses.

Downloads

18

Readme

Jsonapi-formatter.js npm version license type npm downloads ECMAScript 6

ES6 Component that works as an omnirouter middleware to provide jsonapi responses.

import JsonApiFormatter from "jsonapi-formatter";
import Router from "omnirouter";

router = new Router(options);
router.get("/user", (request, response) => {
	response.internalServerError(new Error("Oh no!"));
});
//inject middleware
router.use(JsonApiFormatter);
router.listen(portNumber, () => {
	//now your responses will return an envelope according to the [jsonapi format](http://jsonapi.org/format) (notice that the entities you may return inside of it are not automatically converted, currently)
}));

Quality and Compatibility

Build Status Coverage Status Code Climate Dependency Status Dev Dependency Status

Every build and release is automatically tested on the following platforms:

node 0.12.x node 0.11.x node 0.10.x iojs 2.x.x iojs 1.x.x

If your platform is not listed above, you can test your local environment for compatibility by copying and pasting the following commands into your terminal:

npm install jsonapi-formatter
cd node_modules/jsonapi-formatter
gulp test-local

Installation

Copy and paste the following command into your terminal to install Jsonapi-formatter:

npm install jsonapi-formatter --save

Import / Require

// ES6
import jsonapi-formatter from "jsonapi-formatter";
// ES5
var jsonapi-formatter = require("jsonapi-formatter");
// Require.js
define(["require"] , function (require) {
    var jsonapi-formatter = require("jsonapi-formatter");
});

Getting Started

Json Api Formatter formats your response into a format according to the jsonapi format Currently it works as an omnirouter middleware, or manually by calling the methods

  • formatResponse(response) Receives a response object that has at least a set function by now.
  • format(body) Receives a body object to add the envelop to it.

Using it with omnirouter

Example usage with omnirouter

import JsonApiFormatter from "jsonapi-formatter";
import Router from "omnirouter";

router = new Router(options);
router.get("/user", (request, response) => {
	response.internalServerError(new Error("Oh no!"));
});
//inject middleware
router.use(JsonApiFormatter);
router.listen(portNumber, () => {
	//now your responses will return an envelope according to the [jsonapi format](http://jsonapi.org/format) (notice that the entities you may return inside of it are not automatically converted, currently)
}));

How to Contribute

See something that could use improvement? Have a great feature idea? We listen!

You can submit your ideas through our issues system, or make the modifications yourself and submit them to us in the form of a GitHub pull request.

We always aim to be friendly and helpful.

Running Tests

It's easy to run the test suite locally, and highly recommended if you're using Jsonapi-formatter.js on a platform we aren't automatically testing for.

npm test