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-renderer

v1.2.5

Published

Helper for generating jsonapi compliant output from models

Downloads

4

Readme

JSONAPI-Renderer

npm version Build Status codecov.io

This module makes it easy to render a model or an array of models in a format that matches the jsonapi.org specification.

Declaration

The module expects each model to have a jsonapiType property on the model.

Each model type must have their definition registered by passing it to the constructor of the renderer.

{
    'type': The name of the type of model. The name should be the same as the resource in the api,
    'id': The property from which the id of the model can be retrieved. Defaults to `id`,
    'link': A function to generate a link to this resource. The function will be called with the model as the 'this'.
    'attributes': {
        '{attribute name}': {
            'property': The property where the value from the given attribute can be retrieved. This can also reference a function name, which will then be called. Defaults to the name of the attribute.
            'get': A function that will called to retrieve the value for the attribute. The function will be called with the model as the 'this'.
            'format': A function that will be called to format the value. This can f.ex. be used to format a date in a certain way.
            'valid': A function that can be used to indicate if the attribute is valid for this particular model. If it returns false, the attribute will be skipped. The function will be called with the model as the 'this' and the value as the only argument.
            'renderByDefault': True if the attribute should be rendered to the output by default, false otherwise. Defaults to `true`.
        },
        ... more attributes
    },
    'relationships': {
        '{relationship name}': {
             'property': The property where the value from the given attribute can be retrieved. This can also reference a function name, which will then be called. Defaults to the name of the attribute.
            'get': A function that will called to retrieve the value for the attribute. The function will be called with the model as the 'this'.
            'valid': A function that can be used to indicate if the attribute is valid for this particular model. If it returns false, the attribute will be skipped. The function will be called with the model as the 'this' and the value as the only argument.
            'renderByDefault': True if the attribute should be rendered to the output by default, false otherwise. Defaults to `true`.
            'includeByDefault': True if the relationship should be added to the `included` section by default, false otherwise. Defaults to `false`.
        }
    }
}

Short-hand expressions is possible for each attribute and relationship. If the value is a boolean, it will be used as the value for renderByDefault. If the value is a string, it will be used as the value for property. If null or undefined, default values will be used.

Values

Values for attributes should only be primitives, and values for relationships should only be other models.