@mattcbaker/blip

Blip

Blip is making Node HTTP(S) transactions a little more pleasant.

Install

npm i @mattcbaker/blip

Example

const { request } = require('@mattcbaker/blip')

try {
  const result = await request({ url: 'https://httpbin.org/get' })

  console.log(result.body.toString())
} catch (error) {
  // be sure to handle your errors! :)
}

API

request

request({
 url: string,
 headers: {...},
 body: string,
 method: string
})

and the response

{
 statusCode: int,
 headers: {...}
 body: <Buffer ...>
}

Blip has a few opinions (don't we all?)

• The HTTP spec refers to message bodies as "body" and the Blip API reflects that.
• Blip will not return an error based on any status code. For example, Blip will not return an error when a server responds with a 5xx HTTP status code.

Common questions

• Why doesn't the API have methods for each HTTP verb, e.g. GET, POST, PUT?
  • No doubt these convenience methods are handy. But, they aren't without a cost -- increasing the API surface. Blip has chosen to have as small an API surface as possible, so we've decided to forego the verb convenience methods.
• Why return a Buffer for the body?
  • This choice is rooted in the fact that Node is based on streams. Node serves HTTP response bodies in streams, Blip tries to make your life a little easier by loading that stream into a buffer. If you'd like the utf8 encoding of the body, buffer.toString() is your friend.

License

MIT