jsonapi-renderer

JSONAPI-Renderer

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.