pubcore / http-client Goto Github PK

npm i --save @pubcore/http-client

import request from '@pubcore/http-client'

//a get request
request({uri:'https://example.com', query:{id: 42}}).then(
	result => {
		//do something with result ...
	},
	err => {
		//do someging with error ...
	}
)

//post some json, with basic auth
request({uri:'https://example.com', method:'post', username:'foo', password:'...', data:{name:'T-Bone'}, query:{id:42}}).then(
	res => {
		//show feedback
	},
	err => {
		//do someging with error ...
	}
)

✓ defaults to method get and accept application/json
✓ rejects to {code:"REQUEST_ERROR", ...}, e.g. on timeout
✓ rejects 4xx or 5xx to {code:"HTTP_ERROR", ...} (this is expected, not an exception)
✓ serializes query params in "qs" package default format
✓ has "authorization" argument to forward authentication
✓ exports function to create basic-auth value for "authorization" agrument
✓ has usernaame, password arguments for basic authentication
✓ has userAgent argument to define own one
✓ has "data" argument, treated as json (default) for post and put
✓ has "contentType" argument, if set to "urlEncoded" data is converted accordingly
✓ supports optional headers
✓ "__Host-Csrf-Token" cookie is forwarded via HTTP header "X-Csrf-Token" for POST, PUT and DELETE requests

{
	code:'REQUEST_ERROR',
	details: {
		message: 'timeout',
		uri: 'https://example.com/foo?id=12',
		method: 'get'
	}
}

{
	code:'HTTP_ERROR',
	details:{
		body:{status:{code:'ERROR'}},
		headers:{'content-type': 'application/json'},
		message:'Request failed with status code 500',
		status:500,
		method:'get',
		uri:'https://www.example.com/500'
	}
}

{
	status: 200,
	headers: {'Content-Type': 'application/json' //,...}
	body: {foo: bar}
}