The HAL+JSON Resource Object.
3.0.0
npm install halson --save
bower install halson --save
var halson = require('halson');
var embed = halson({
title: "joyent / node",
description: "evented I/O for v8 javascript"
})
.addLink('self', '/joyent/node')
.addLink('author', {
href: '/joyent',
title: 'Joyent'
});
var resource = halson({
title: "john doe",
username: "doe",
emails: [
"[email protected]",
"[email protected]"
]
})
.addLink('self', '/doe')
.addEmbed('starred', embed);
console.log(resource.title);
console.log(resource.emails[0]);
console.log(resource.getLink('self'));
console.log(resource.getEmbed('starred'));
console.log(JSON.stringify(resource));
Create a new HAL+JSON Resource Object.
data
(optional): Initial data as serialized string or Object.
// empty HAL+JSON Resource Object
var resource = halson();
// resource from a serialized data
var resource = halson('{title:"Lorem Ipsum",_links:{self:{href:"/ipsum"}}');
// resource from an Object
resource = halson({
_links: {
self: {
href: {"/ipsum"}
}
},
title: "Lorem Ipsum"
});
// resource from another resource (no-op)
var resourceX = halson(resource);
console.log(resource === resourceX); // true
List all link relations.
var data = {
_links: {
self: {href: '/doe'},
related: [
{href: 'https://doe.com'},
{href: 'https://twitter.com/doe'}
]
}
}
var resource = halson(data);
console.log(resource.listLinkRels()); // ['self', 'related']
List all link relations.
var data = {
_embedded: {
starred: {
_links: {
self: {href: '/joyent/node'}
}
title: "joyent / node",
description: "evented I/O for v8 javascript"
}
}
}
var resource = halson(data);
console.log(resource.listEmbedRels()); // ['starred']
Get all links with relation rel
.
rel
(required): Relation name.filterCallback
(optional): Function used to filter array of links. docbegin
,end
(optional): slice filtered links. doc
var twitterLinks = resource.getLinks('related', function(item) {
return item.name === "twitter";
});
Get first link with relation rel
.
rel
(required): Relation name.filterCallback
(optional): Function used to filter array of links. docdefault
(optional): Default value if the link does not exist.
var firstRelatedLink = resource.getLink('related');
Get all embedded resources with relation rel
.
rel
(required): Relation name.filterCallback
(optional): Function used to filter array of embeds. docbegin
,end
(optional): slice filtered links. doc
var embeds = resource.getEmbeds('starred');
Get first embedded resource with relation rel
.
rel
(required): Relation name.filterCallback
(optional): Function used to filter array of embeds. docdefault
(optional): Default value if the link does not exist.
var nodeProject = resource.getEmbed('starred', function(embed) {
return embed.getLink('self', {}).href === '/joyent/node';
});
Add a link with relation rel
.
rel
(required): Relation name.link
(required): Link to be added (string or Object).
resource
.addLink('related', 'https://doe.com')
.addLink('related', {
href: 'https://twitter.com/doe',
name: 'twitter'
});
Add a nested resource with relation rel
.
rel
(required): Relation name.embed
(required): Resource to be embedded (Object or HALSONResource).
var embed = {
_links: {
self: {href: '/joyent/node'}
},
title: "joyent / node"
}
resource.addEmbed('starred', embed);
Add a nested resource with relation rel
.
rel
(required): Relation name.index
(required): Index number where embed will be insertedembed
(required): Resource to be embedded (Object or HALSONResource).
var embed = {
_links: {
self: {href: '/joyent/node'}
},
title: "joyent / node"
};
resource.addEmbed('starred', embed); // add embed
var embed2 = {
_links: {
self: {href: '/joyent/node'}
},
title: "joyent / node"
};
resource.insertEmbed('starred', 0, embed2); // insert new embed before first item
Remove links with relation rel
. If filterCallback
is not defined, all links with relation rel
will be removed.
rel
(required): Relation name.filterCallback
(optional): Function used to filter array of links. doc
// remove links with relation 'related' and name 'twitter'
resource.removeLinks('related', function(link) {
return link.name === "twitter";
});
Remove embedded resources with relation rel
. If filterCallback
is not defined, all embeds with relation rel
will be removed.
rel
(required): Relation name.filterCallback
(optional): Function used to filter array of links. doc
// remove embedded resources with relation 'starred' and self-link '/koajs/koa'
resource.removeLinks('starred', function(embed) {
return embed.getLink('self', {}).href === '/koajs/koa';
});