h5.linkformat
Partial implementation of the
RFC-6690 (Constrained RESTful Environments (CoRE) Link Format)
and
draft-bormann-core-links-json-01
(Representing CoRE Link Collections in JSON) for node.js and the browser.
Why partial? Because the following features are not supported
(see
Link Format section of the RFC):
- validation of the parameter values (e.g.
foobar will be accepted as a value
for the
sz parameter).
-
ext-name-star in
link-extension (see
RFC-2231 ).
Usage
``
js
'
`
example/ directory .
API
$3
Array.
parse(string input[, object options])
input - a required string in the CoRE Link Format to parse.
options - an optional options object. Valid options include:
allowMultiple - whether multiple values for params should be allowed. Defaults to true.
coerce - whether to coerce unquoted param values to JavaScript types. Defaults to false.
quotedValueConverter - a mixed function(string quotedValue) used to convert quoted param
\t with \\t, \r\n with and then parses the resulting value as a JSON string
JSON.parse()).
href property.
quotedValueConverter does.
$3
Array. filter(Array. links, string paramName, mixed paramValue)
Array. filter(Array. links, object criteria)
links - an array of link objects to filter.
paramName - a param name to match.
paramValue - a param value to match.
*, then any value is accepted (only checks whether
*.
criteria - a map of param names to param values to match. Specifying paramName
paramValue is the same as:
`js
`
$3
string toString(Array. links)
links - an array of link objects to serialize to a string.
$3
index module exports a special, wrapped version of the parse module.
toString() and filter() methods of the returned links array are replaced with the functions
toString and filter modules. Also, the toString() method of the filtered links array
toString module.
`js
`
`js
`
filter() method for more complex filtering still works.
Browser build (AMD)
`
`
build/lib-amd/ directory.
Tests
`
`
Grunt is installed globally:
Getting Started guide ).
`
`
`
`
grunt test command.
grunt coverage command.
build/coverage/
build/coverage/lcov-report/index.html file.
License
MIT License .
$3
mkovatsc/Copper project (specifically
CopperChrome.parseLinkFormat()`)