halpert
Package for converting from one media type to another
Last updated 6 years ago by smizell .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install halpert 
SYNC missed versions from official npm registry.

Halpert

Build Status

Halpert is a library for representing and interfacing with hypermedia formats. It provides a way for converting to and from these formats, along with methods for filtering and parsing through them in a general way.

Install

Use npm to install halpert.

npm install halpert

Supported Formats

  • HAL+JSON - Currently only parses HAL objects

Usage

Initializing and Registering Formats

To initialize a Halpert object and register the formats, require the halpert package along with any formats desired. The example below includes the HAL+JSON format.

var Halpert = require('halpert'),
    halJson = require('halpert-hal-json');

halpert = new Halpert;
halpert.registerFormat(halJson);

Representing Documents

Once you have a Halpert object like above, you can then start representing documents.

var doc = {
  _links: { self: { href: "/customer/4" }},
  full_name: "John Doe",
  email: "john@doe.com"
}

represnter = halpert.represent(doc, 'application/hal+json');

Contributing

  • Please make sure all contributions are covered by tests
  • Run gulp build once all changes are complete

Current Tags

  • 0.2.3                                ...           latest (6 years ago)

9 Versions

  • 0.2.3                                ...           6 years ago
  • 0.2.1                                ...           6 years ago
  • 0.2.0                                ...           6 years ago
  • 0.1.0                                ...           6 years ago
  • 0.0.5                                ...           6 years ago
  • 0.0.4                                ...           6 years ago
  • 0.0.3                                ...           6 years ago
  • 0.0.2                                ...           6 years ago
  • 0.0.1                                ...           6 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (1)
Dev Dependencies (9)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |