Skip to content package
solicit v0.0.7 a declarative http client for node and browser
node any 12 deps cjs open source
overview readme
license Unknown
deps 12
unpacked Unknown
files Unknown
node any $ npm install solicit@0.0.7n npmREADME GitHub-flavored package documentation.
downloads Across all versions.
Download trend unavailable.
compatibility Runtime metadata.
versions Latest published May 22, 2016
maintainers Registry package owners.
contents solicit
A declarative http client based off superagent . Versions available for both the browser and node with the same API and shared test suite.
Installation
npm install solicit
then in your app:
import {get,post,del} from 'solicit' copy
Example
get ( 'component.io/components/all' ). read (console.log) // => a whole lot of JSON copy
API
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:
install size Estimated unpacked size across 35 packages.
932.2 kB
Includes dependencies.
dependencies 11 direct · 1 outdated
get
post
put
head
del (delete is a reserved word in JS)
Request.set(field:String|Object, val:String) Set header field to val, or multiple fields with one object.
get ( '/' )
. set ( 'Accept' , 'application/json' )
. set ( 'X-API-Key' , 'foobar' )
. read (callback) copy get ( '/' )
. set ({ Accept: 'application/json' , 'X-API-Key' : 'foobar' })
. read (callback) copy
Request.get(field) Get request header field.
Request.query(val:Object|String) get ( '/shoes' )
. query ( 'size=10' )
. query ({ color: 'blue' }) copy
Request.type(type) Set the "Content-Type" header. Common types can
be set with a shorthand string:
post ( '/' )
. type ( 'application/json' )
. send (jsonstring)
. read (callback) copy post ( '/' )
. type ( 'json' )
. send (jsonstring)
. read (callback) copy
Request.accept(type) Set the "Accept" header. As with Request.type()
shorthand strings are allowed
Request.timeout(ms)
Request.clearTimeout()
Request.abort()
Request.agent(agent:http.Agent) 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).
Request.send(data:String|Object) Send data, defaulting the .type() to "json" when
an object is given.
// manual json
post ( '/user' )
. type ( 'json' )
. send ( '{"name":"tj"}' )
. read (callback) copy // auto json
post ( '/user' )
. send ({ name: 'tj' })
. read (callback) copy // manual x-www-form-urlencoded
post ( '/user' )
. type ( 'form' )
. send ( 'name=tj' )
. read (callback) copy // auto x-www-form-urlencoded
post ( '/user' )
. type ( 'form' )
. send ({ name: 'tj' })
. read (callback) copy // string defaults to x-www-form-urlencoded
post ( '/user' )
. send ( 'name=tj' )
. send ( 'foo=bar' )
. send ( 'bar=baz' )
. read (callback) copy
Request.auth(user, pass) Set Authorization field value with user and pass
Request.maxRedirects(n) Set the max redirects to n.
Request.path(...) Set the path. arguments is joined to form the path:
get ( 'https://api.github.com' )
. path ( 'repos' , user, repo, 'tags' )
. read (callback) copy
Request.write(data:Buffer|String, [encoding='utf8']) Write data to the socket.
Request.end([data]:Buffer|String, [encoding='utf8'])
Request.pipe(stream, options) Pipe the request body to stream
path github:jkroso/path#1.1.0