params

[refractalize]

Params

Httpism will render a URL template if the params option is used, the params are interpolated into the URL template, any params left over will form the query string.

httpism.get('http://example.com/users/:user/posts', {
  params: {
    user: 'bob',
    page: 3,
    search: 'lakes'
  }
})

Will become

GET http://example.com/users/bob/posts?page=3&search=lakes

A template contains two forms of parameter, varying on the way special characters are encoded for URLs.

• :param - uses encodeURIComponent, and is useful for most applications
• :param* - uses encodeURI and can be used to interpolate paths, such as a/path/to/something without encoding the slash characters.

Any remaining parameters will be encoded in the query string, you can override how the query string is encoded using the qs option.

The template interpolation itself can be overridden with the expandUrl option, and is used as follows:

var url = expandUrl(template, params, querystring)

• template - the URL template, passed in as the url argument to httpism.get, etc.
• params - the object containing the parameters to be interpolated.
• querystring - the qs option, can be used to encode the query string parameters, e.g. querystring.stringify(params).

For example, you could use RFC 6570 templates like this

var urlTemplate = require('url-template')

function expandUrl(url, params) {
  var template = urlTemplate.parse(url)
  return template.expand(params)
}

httpism.get('http://example.com/users/{user}/posts{?page,search}', {
  params: {
    user: 'bob',
    page: 3,
    search: 'lakes'
  },
  expandUrl: expandUrl
})

Or indeed create a new client to use this by default:

var httpism = require('httpsim').client({
  expandUrl: expandUrl
})

httpism.get('http://example.com/users/{user}/posts{?page,search}')

[dereke]

@refractalize this looks great!