0.0.10 • Published 10 years ago
connect-hal-builder v0.0.10
request-hal-builder
Getting Started
npm install request-hal-representation --save
API
req.halBuilder.listLinkRels()
List all link relations.
req.halBuilder.listEmbedRels()
List all link relations.
req.halBuilder.getLinks(rel, [filterCallback, [begin, [end]]])
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
req.halBuilder.getLink(rel, [filterCallback, [default]])
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.
req.halBuilder.getEmbeds(rel, [filterCallback, [begin, [end]]])
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
req.halBuilder.getEmbed(rel, [filterCallback, [default]])
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.
req.halBuilder.addLink(rel, link)
Add a link with relation rel
.
rel
(required): Relation name.link
(required): Link to be added (string or Object).
req.halBuilder.addEmbed(rel, embed)
Add a nested resource with relation rel
.
rel
(required): Relation name.embed
(required): Resource to be embedded (Object or HALSONResource).
req.halBuilder.insertEmbed(rel, index, 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).
req.halBuilder.removeLinks(rel, [filterCallback])
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
req.halBuilder.removeEmbeds(rel, [filterCallback])
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
Helpful Links
http://haltalk.herokuapp.com/explorer/browser.html#/