yayson
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/yayson package

    2.1.0 • Public • Published

    YAYSON

    A library for serializing and reading JSON API data in JavaScript. As of 2.0.0 YAYSON aims to support JSON API version 1.

    NPM

    Installing

    Install yayson by running:

    $ npm install yayson --save
    

    Presenting data

    A basic Presenter can look like this in Coffeescript:

      {Presenter} = require('yayson')(adapter: 'default')
    
      class ItemsPresenter extends Presenter
        type: 'items'
    
      item =
        id: 5
        name: 'First'
    
      ItemsPresenter.render(item)

    Or in plain JavaScript:

      const Presenter = require('yayson')({
        adapter: 'default'
      }).Presenter;
    
      class ItemsPresenter extends Presenter {};
      ItemsPresenter.prototype.type = 'items';
    
      var item = {
        id: 5,
        name: 'First'
      };
    
      ItemsPresenter.render(item);

    This would produce:

    {
      data: {
        id: 5,
        type: 'items',
        attributes: {
          id: 5,
          name: 'First'
        }
      }
    }

    It also works with arrays, so if you send an array to render, "data" will be an array.

    A bit more advanced example:

      {Presenter} = require('yayson')(adapter: 'default')
    
      class ItemsPresenter extends Presenter
        type: 'items'
    
        attributes: ->
          attrs = super
          attrs.start = moment.utc(attrs.start).toDate()
          attrs
    
        relationships: ->
          event: EventsPresenter
    
      ItemsPresenter.render(item)

    In JavaScript this would be done as:

    var Presenter = require('yayson')().Presenter;
    
    class ItemsPresenter extends Presenter {};
    ItemsPresenter.prototype.type = 'items'
    
    ItemsPresenter.prototype.attributes = function() {
      var attrs = Presenter.prototype.attributes.apply(this, arguments);
    
      attrs.start = moment.utc(attrs.start).toDate();
      return attrs;
    }
    
    ItemsPresenter.prototype.relationships = function() {
      return {
        event: EventsPresenter
      }
    }
    
    ItemsPresenter.render(item)

    Sequelize support

    By default it is set up to handle standard JS objects. You can also make it handle Sequelize.js models like this:

    {Presenter} = require('yayson')({adapter: 'sequelize'})

    You can also define your own adapter globally:

    {Presenter} = require('yayson')(adapter: {
      id: function(model){ return 'omg' + model.id},
      get: function(model, key){ return model[key] }
    })

    Or at Presenter level:

    ItemPresenter.adapter = {
      id: function(model){ return 'omg' + model.id},
      get: function(model, key){ return model[key] }
    }

    Take a look at the SequelizeAdapter if you want to extend YAYSON to your ORM. Pull requests are welcome. :)

    Metadata

    You can add metadata to the top level object.

      ItemsPresenter.render(items, meta: count: 10)

    This would produce:

    {
      meta: {
        count: 10
      }
      data: {
        id: 5,
        type: 'items',
        attributes: {
          id: 5,
          name: 'First'
        }
      }
    }

    Parsing data

    You can use a Store can like this:

        {Store} = require('yayson')()
        store = new Store()
    
        adapter.get(path: '/events/' + id).then (data) ->
          event = store.sync(data)

    This will give you the parsed event with all its relationships.

    Use in the browser

    Recommended way is to use it via webpack or similar build system wich lets you just require the package as usual.

    If you just want to try it out, copy the file dist/yayson.js to your project. Then simply include it:

        <script src="./lib/yayson.js"></script>

    Then you can var yayson = window.yayson() use the yayson.Presenter and yayson.Store as usual.

    Browser support

    Tested

    • Chrome
    • Firefox
    • Safari
    • Safari iOS

    Untested, but should work

    • IE 9+
    • Android

    Install

    npm i yayson

    DownloadsWeekly Downloads

    1,000

    Version

    2.1.0

    License

    MIT

    Unpacked Size

    33.1 kB

    Total Files

    18

    Last publish

    Collaborators

    • avatar
    • avatar