url-assembler

node-url-assembler

Assemble urls from route-like templates (/path/:param)

Chainable utility to assemble URLs from templates

Installation

npm install --save url-assembler

Usage

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 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/admins/users/floby"

You can also incrementally build your URL.

UrlAssembler('https://api.site.com/')
  .prefix('/v2')
  .segment('/users/:user')
  .segment('/projects/:project_id')
  .segment('/summary')
  .param({
    user: 'floby',
    project_id: 'node-url-assembler'
  })
  .toString() // => 'https://api.site.com/users/floby/projects/node-url-assembler/summary'

Every method (except toString()) returns a new instance of UrlAssembler. You can consider UrlAssembler instances as immutable.

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.

Test

Tests are written with mocha and covered with istanbul You can run the tests with npm test.

Contributing

Anyone is welcome to submit issues and pull requests

License

MIT

Copyright (c) 2014 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.