solicit

a declarative http client for node and browser

solicit

A declarative http client based off superagent. Versions available for both the browser and node with the same API and shared test suite.

With your favorite package manager:

  • packin: packin add solicit
  • component: component install jkroso/solicit
  • npm: npm install solicit

then in your app:

var request = require('solicit')
request.get('component.io/components/all').read(console.log) // => a whole lot of JSON 

Solicit.verb(url:String|Object)

Each http verb has a corresponding helper function for making that type of request. Each function will return a Request. Requests are deferred results so you are free to configure them as much as you like with the methods mentioned below then call read() or then() to actually send the request and read the response. The main verbs you will be using are:

  • get
  • post
  • put
  • head
  • delete

Set header field to val, or multiple fields with one object.

Examples:

request.get('/')
  .set('Accept', 'application/json')
  .set('X-API-Key', 'foobar')
  .read(callback)
request.get('/')
  .set({ Accept: 'application/json', 'X-API-Key': 'foobar' })
  .read(callback)

Get request header field.

Add query-string val.

Examples:

request.get('/shoes')
  .query('size=10')
  .query({ color: 'blue' })

Set the "Content-Type" header. Common types can be set with a shorthand string:

request.post('/')
  .type('application/json')
  .send(jsonstring)
  .read(callback)
request.post('/')
  .type('json')
  .send(jsonstring)
  .read(callback)

Set the "Accept" header. As with Request.type() shorthand strings are allowed

Set timeout to ms.

Clear previous timeout.

Abort and clear timeout.

Gets/sets the Agent to use for this HTTP request. The default (if this function is not called) is to opt out of connection pooling (agent: false).

Send data, defaulting the .type() to "json" when an object is given.

Examples:

// manual json 
request.post('/user')
  .type('json')
  .send('{"name":"tj"}')
  .read(callback)
// auto json 
request.post('/user')
  .send({ name: 'tj' })
  .read(callback)
// manual x-www-form-urlencoded 
request.post('/user')
  .type('form')
  .send('name=tj')
  .read(callback)
// auto x-www-form-urlencoded 
request.post('/user')
  .type('form')
  .send({ name: 'tj' })
  .read(callback)
// string defaults to x-www-form-urlencoded 
request.post('/user')
  .send('name=tj')
  .send('foo=bar')
  .send('bar=baz')
  .read(callback)

Set Authorization field value with user and pass

Set the max redirects to n.

Set the path. arguments is joined to form the path:

get('https://api.github.com')
  .path('repos', user, repo, 'tags')
  .read(callback)

Write data to the socket.

send request

Pipe the request body to stream