Global - Documentation

Methods

asBody()

Source:

client.js, line 289

Initiates the request, returning the response body, if successful.

Example

const httpTransport = require('http-transport');
 
const response = httpTransport.createClient()
   .asBody()
   .then((body) => {
     console.log(body);
   });

Returns:

a Promise. If the Promise fulfils, the fulfilment value is the response body, as a string by default.

asResponse()

Source:

client.js, line 309

Initiates the request, returning a http transport response object, if successful.

Example

const httpTransport = require('http-transport');
 
const response = httpTransport.createClient()
   .asResponse()
   .then((body) => {
     console.log(body);
   });

Returns:

a Promise. If the Promise fulfils, the fulfilment value is response object.

get(url)

Source:

client.js, line 64

Make a HTTP GET request

Example

const httpTransport = require('http-transport');
 
const response = httpTransport.createClient()
   .get(url)
   .asResponse();

Parameters:

Name	Type	Description
`url`	string

Returns:

a HttpTransport instance

head(url)

Source:

client.js, line 176

Make a HTTP HEAD request

Example

const httpTransport = require('http-transport');
 
const response = httpTransport.createClient()
   .head(url)
   .asResponse();

Parameters:

Name	Type	Description
`url`	string

Returns:

a HttpTransport instance

headers(name, value)

Source:

client.js, line 197

Sets the request headers

Example

const httpTransport = require('http-transport');
 
const response = httpTransport.createClient()
   .headers({
     'User-Agent' : 'someUserAgent' 
   })
   .asResponse();

Parameters:

Name	Type	Description
`name`	string \| object	header name or headers object
`value`	string \| object	header value

Returns:

a HttpTransport instance

post(url, request)

Source:

client.js, line 131

Make a HTTP DELETE request

Example

const httpTransport = require('http-transport');
 
const response = httpTransport.createClient()
   .delete(url)
   .asResponse();

Parameters:

Name	Type	Description
`url`	string
`request`	object	body

Returns:

a HttpTransport instance

post(url, request)

Source:

client.js, line 153

Make a HTTP PATCH request

Example

const httpTransport = require('http-transport');
 
const response = httpTransport.createClient()
   .put(url, requestBody)
   .asResponse();

Parameters:

Name	Type	Description
`url`	string
`request`	object	body

Returns:

a HttpTransport instance

post(url, request)

Source:

client.js, line 108

Make a HTTP PUT request

Example

const httpTransport = require('http-transport');
 
const response = httpTransport.createClient()
   .put(url, requestBody)
   .asResponse();

Parameters:

Name	Type	Description
`url`	string
`request`	object	body

Returns:

a HttpTransport instance

post(url, request)

Source:

client.js, line 85

Make a HTTP POST request

Example

const httpTransport = require('http-transport');
 
const response = httpTransport.createClient()
   .post(url, requestBody)
   .asResponse();

Parameters:

Name	Type	Description
`url`	string
`request`	object	body

Returns:

a HttpTransport instance

query(name, value)

Source:

client.js, line 224

Sets the query strings

Example

const httpTransport = require('http-transport');
 
const response = httpTransport.createClient()
   .query({
     'perPage' : 1 
   })
   .asResponse();

Parameters:

Name	Type	Description
`name`	string \| object	query name or query object
`value`	string \| object	query value

Returns:

a HttpTransport instance

retry(timeout)

Source:

client.js, line 270

Set the number of retries on failure

Example

const httpTransport = require('http-transport');
 
const response = httpTransport.createClient()
   .retry(5)
   .asResponse();

Parameters:

Name	Type	Description
`timeout`	integer	number of times to retry a failed request

Returns:

a HttpTransport instance

timeout(timeout)

Source:

client.js, line 251

Sets a request timeout

Example

const httpTransport = require('http-transport');
 
const response = httpTransport.createClient()
   .timeout(1)
   .asResponse();

Parameters:

Name	Type	Description
`timeout`	integer	timeout in seconds

Returns:

a HttpTransport instance

use(fn)

Source:

client.js, line 44

Registers a per request plugin

Example

const toError = require('http-transport-errors'); 
const httpTransport = require('http-transport');
 
httpTransport.createClient()
   .use(toError(404));

Parameters:

Name	Type	Description
`fn`	function	per request plugin

Returns:

a HttpTransport instance

useGlobal(fn)

Source:

client.js, line 24

Registers a global plugin, which is used for all requests

Example

const toError = require('http-transport-errors'); 
const httpTransport = require('http-transport');
 
const client = httpTransport.createClient();
client.useGlobal(toError(404));

Parameters:

Name	Type	Description
`fn`	function	a global plugin

Returns:

a HttpTransport instance