Assemble urls from route-like templates (/path/:param)
Chainable utility to assemble URLs from templates
npm install --save url-assembler
UrlAssembler()
.template('/users/:user')
.param('user', 8)
.param('include', 'address')
.query({
some: 'thing',
other: 1234
})
.toString() // => "/users/8?include=address&some=thing&other=1234
Since you more often than not need a hostname and a protocol to go with this
UrlAssembler('http://my.domain.com:9000')
.template('/groups/:group/users/:user')
.param({
group: 'admin',
user: 'floby'
})
.toString() // => "http://my.domain.9000/groups/admin/users/floby"
You can also incrementally build your URL.
UrlAssembler('https://api.site.com/')
.prefix('/v2')
.segment('/users/:user')
.segment('/projects/:project')
.segment('/summary')
.param({
user: 'floby',
project: 'node-url-assembler'
})
.toString() // => 'https://api.site.com/v2/users/floby/projects/node-url-assembler/summary'
If url-assembler
finds the request
module. Then a .request
property
is available on every instance which can be used to make requests.
var google = UrlAssembler('https://google.com').query('q', 'url assembler');
google.request.get() // => makes a GET request to google
// you can still pass any other option to request
google.request.get({json: true})
Every method (except toString()
) returns a new instance of UrlAssembler
. You can
consider that UrlAssembler
instances are immutable.
Because of this, you can use a single instance as a preconfigured url to reuse throughout your codebase.
var api = UrlAssembler('http://api.site.com');
var userResource = api.segment('/users/:user');
var userV1 = userResource.prefix('/v1');
var userV2 = userResource.prefix('/v2');
var userFeedResource = userV2.segment('/feed');
var authenticated = api.query('auth_token', '123457890');
var adminResource = authenticated.segment('/admin');
In addition, an instance of UrlAssembler
is a valid object to pass
to url.format()
or any function accepting this kind of object as
parameter.
baseUrl
: will be used for protocol, hostname, port and other base url kind of stuff.- returns an instance of a URL assembler.
urlAssembler
: an existing instance ofUrlAssembler
- this constructor is used for chaining internally. You should be aware of it if you extend
UrlAssembler
- returns a new instance of a URL assembler, copying the previous one
template
a string with dynamic part noted as:myparam
. For example'/hello/:param/world'
- returns a new instance of
UrlAssembler
with this template configured
subPath
: this string will be added at the beginning of the path part of the URL- if called several times, the
subPath
will be added after the previous prefix but before the rest of the path - returns a new instance of
UrlAssembler
subPathTemplate
is a string of a segment to add to the path of the URL. It can have a templatized parameter eg.'/user/:user'
- if called several times, the segment will be added at the end of the URL.
- returns a new instance of
UrlAssembler
key
: a string of the dynamic part to replacevalue
: a string to replace the dynamic part with- returns a new instance of
UrlAssembler
with the parameterkey
replaced withvalue
. Ifstrict
is falsy, the key will be added as query parameter.
params
: a hash of key/value to give to the method abovestrict
a flag passed to the method above- returns a new instance of
UrlAssembler
with all the parameters from theparams
replaced
key
: the name of the parameter to configurevalue
: the value of the parameter to configure- returns a new instance of
UrlAssembler
with thekey=value
pair added as query parameter with theqs
module.
- shortcut for the previous method with a hash of key/value.
- add config supported by qs.stringify https://www.npmjs.com/package/qs version ^6.5.1
- returns a string of the current state of the
UrlAssembler
instance. Path parameters not yet replaced will appear as:param_name
.
Tests are written with mocha and covered with istanbul
You can run the tests with npm test
.
Anyone is welcome to submit issues and pull requests
Copyright (c) 2015 Florent Jaby
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.