http-ok

http-ok

coverage status

A simple promise based http client which rejects the promise when the status is not 200 - OK

Motivation

Instead of having if-statements to check the http status code when a request returns, http-ok rejects the promise when the status code is not as expected (by default 200). This should make the promise chain look much simpler and more focused on the succes flow.

Example using 'http-ok':

const HttpOk = require("http-ok")
const client = new HttpOk(); 

client.get('www.google.com')
  .then(response => {
    /// process here the response
  })
  .catch(error => {
    /// error handling here
  }
});

Example using a http-client like 'node-fetch':

const fetch = require("node-fetch");

fetch('www.google.com')
  .then(response => {
      if(response.statusCode === 200) {
        /// process here the response
      } else {
        // error handling here
      }
    }
  ).catch(err => {
  	// error handling here
  });

Features

• More natural promise chain by rejecting the promise when the response code is not OK
• Stay consistent with node http API. Uses the same request options object.
• Use native promise.

Difference from node-fetch

• See Link to Header for details.

Install

npm install http-ok --save

Usage

plain text or html

const HttpOk = require('http-ok');
const client = new HttpOk();

client.get('https://github.com/')
	.then(res => res.text())
	.then(bodyText => console.log(bodyText))
	.catch(err => console.log(err));

json response

client.get('https://api.github.com/users/github')
	.then(res => res.json())
	.then(json => console.log(json))
	.catch(err => console.log(err));

post with form data and custom headers

const querystring = require('querystring');
const formData = { 
    name: 'Bob Mc Bobson', 
    place: 'Cheddar' 
};
const postData = querystring.stringify(formData);

const requestOptions = {
    hostname: 'http://httpbin.org',
    headers: {
         'Content-Type': 'application/x-www-form-urlencoded',
         'Content-Length': Buffer.byteLength(postData)
    }
};

client.post(requestOptions, postData, 200)
	.then(res => {
		// process here the response
	}).catch(json => {
		// error handling here
	});

specific success case eg. 302

client.get('http://redirected.com', 302)
     .then(response => {
         // process here the response
     }).catch(error => {
         // error handling here
     });

See test cases for more examples.

API

• get(url) // default 200

• get(url, expectedStatusCode)

• get(options, expectedStatusCode)

• post(url, postData) // default 200

• post(url, postData, expectedStatusCode)

• post(options, postData, expectedStatusCode)

Returns a Promise

url

Should be an absolute url, eg http://example.com

options

same as node.js http.request options.

expectedStatusCode

and integer eg 200 or 301

postData

url encoded string

License

MIT