URI Templates (RFC6570) library including de-substitution.
It also supports URI maps using pairs of templates.
Templates and maps methods can also be exported as code (function expression). The code is smaller than the module (a few hundred bytes instead of a few thousand) so could be included in autogenerated files instead of depending on the module.
The "de-substitution" extracts parameter values from URIs. It is also tested against the official test suite (including extended tests).
UriTemplate
This module loads as a CommonJS/Node, an AMD module or a browser global (UriTemplate);
var UriTemplate = require('uri-templates-codegen');// Use of "new" is optionalvar template1 = UriTemplate("/date/{colour}/{shape}/");var template2 = new UriTemplate("/prefix/{?params*}");
Options
You can supply an options object as a second argument: UriTemplate(str, {...}). Available options are:
.object: the input to .fill() will always be an object, not a function.
.fixedTypes: guarantees the types of some expressions:
{?query*}, {&query*} and {;query*} are always objects (even without '=' present)
{/list*} and {.list*} are always arrays (even when empty)
A function expression for this method is available in .fillUriCode.
UriTemplate.Map
You can define a URI map by supplying pairs of templates in an object. The "forward" direction uses the key template extracts parameters and (if it matches) fills the value template with those parameters.
The code generated by a map is smaller than the codes for the individual templates, because of shared code.
var UriTemplateMap = require('uri-templates-codegen').Map;// A simple object will product a mapvar map = UriTemplateMap({ "/foo/{value}": "/bar/{value}", "/users/{user}/{postId}": "{?user,postId}"});// If more than one might match, use an array to specify ordervar map = UriTemplateMap([ {"/foo/{value}": "/bar/{value}"}, {"/{+url}": "/prefix/{+url}"}]);
.forward()
var preUrl = '/foo/someValue';var postUrl = map.forward(preUrl);// postUrl: "/bar/someValue"
A function expression for this method is available in .forwardCode.
.reverse()
var postUrl = '/bar/someValue';var preUrl = map.reverse(preUrl);// postUrl: "/fpp/someValue"
A function expression for this method is available in .reverseCode.
.mapCode
Returns an expression (immediately-executed function) that returns an object with .forward() and .reverse() methods.
Because of shared code, this is shorter than joining .forwardCode and .reverseCode together.
License
This project is released as public-domain. Anybody can modify or re-license it for any purpose, without restriction.