hyperdescribe-hal-json

Hyperdescribe for HAL+JSON Media Type

This is a library for converting from HAL+JSON to Hyperdescribe and back

Usage

To install:

npm install hyperdescribe-hal-json

Converting to Hyperdescribe

var halDoc = require('./examples/source.hal'),
    HyperdescribehalJSON = require('hyperdescribe-hal-json'),
    hyperdescribeDoc = HyperdescribeHalJSON.describer(halDoc);

Converting from Hyperdescribe

var hyperdescribeDoc = require('./examples/source.hyperdescribe'),
    HyperdescribehalJSON = require('hyperdescribe-hal-json'),
    halDoc = HyperdescribeHalJSON.builder(hyperdescribeDoc);

Browser Version

There is also a browser version in the dist directory.

• Development
• Production

Documented Code

Literate Coffeescript was used to document the code.

• Describer
• Builder