hyperdescribe-hal-json

0.0.2 • Public • Published

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.

Documented Code

Literate Coffeescript was used to document the code.

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 0.0.2
    1
    • latest

Version History

  • Version
    Downloads (Last 7 Days)
    • Published
  • 0.0.2
    1
  • 0.0.1
    1

Package Sidebar

Install

npm i hyperdescribe-hal-json

Weekly Downloads

2

Version

0.0.2

License

MIT

Last publish

Collaborators

  • smizell