halbert

a HAL (Hypertext Application Language) parser

#HALbert

HAL stands for Hypermedia Application Language. It proposes a media type for representing resources and their relations with hyperlinks.

This JS implementation is for the HAL-JSON variant, having the media type application/hal+json.

HAL-JSON is currently at its 5th revision as an Internet Draft at the IETF, and can be read here.

This Javascript implementation has been made to be mostly compliant with the current draft. The divergences with the draft being:

  • _links_ is still optional to a Resource, but if present, it MUST contain a self entry
  • Validation of templated URIs has not been implemented.

Installation

Install it via NPM:

npm install halbert

Then in your code

var parser = require('halbert').parser;

You can build halbert by using browserify.

%ROOT_PATH%/node_modules/browserify/bin/cmd.js -r index

Then in your code

parser = require('./index').parser;

Usage

Simply execute

var resource = parser(json_object)

If for any reason, the json_object does not describe a valid HAL Resource, an Error will be thrown.

Roadmap

  • Add examples for various situations (Node.js, Express, Ember, Angular, Backbone...)
  • Extend the scope to make it a writer of HAL Resources as well as a parser.
  • Better code documentation

License

MIT, see LICENSE.md