Class: HttpClient

HttpClient()

new HttpClient()

HTTP Client

Source:

core/http.js, line 33

Classes

HttpClient
HttpClient

Methods

(async) beforeError(err) → {Promise.<boolean>}

hook async function called before throw an error.

Parameters:

Name	Type	Description
`err`	HttpError	request path

Source:

core/http.js, line 75

Returns:

- if return false, stop throwing the error.

Type: Promise.<boolean>

(async) beforeError(err) → {Promise.<boolean>}

hook async function called before throw an error.

Parameters:

Name	Type	Description
`err`	HttpError	request path

Source:

core/http.js, line 75

Returns:

- if return false, stop throwing the error.

Type: Promise.<boolean>

(async) beforeRequest(path, ctxopt)

hook async function called before the request.

Parameters:

Name Type Attributes Description

path String request path

ctx

object

context

Properties

Name	Type	Attributes	Description
`query`	object	<optional>	request query data
`body`	object	<optional>	request body
`headers`	object	<optional>	header name and value object

Source:

core/http.js, line 67

(async) beforeRequest(path, ctxopt)

hook async function called before the request.

Parameters:

Name Type Attributes Description

path String request path

ctx

object

context

Properties

Name	Type	Attributes	Description
`query`	object	<optional>	request query data
`body`	object	<optional>	request body
`headers`	object	<optional>	header name and value object

Source:

core/http.js, line 67

delete(path, ctxopt) → {Promise.<{status:number, headers:object, body: *}>}

do DELETE request.

Parameters:

Name Type Attributes Description

path String request path

ctx

object

context

Properties

Name	Type	Attributes	Description
`query`	object	<optional>	request query data
`body`	object	<optional>	request body
`headers`	object	<optional>	header name and value object

Source:

core/http.js, line 149

Returns:

Promise resolving to an object with response details

Type: Promise.<{status:number, headers:object, body: *}>

delete(path, ctxopt) → {Promise.<{status:number, headers:object, body: *}>}

do DELETE request.

Parameters:

Name Type Attributes Description

path String request path

ctx

object

context

Properties

Name	Type	Attributes	Description
`query`	object	<optional>	request query data
`body`	object	<optional>	request body
`headers`	object	<optional>	header name and value object

Source:

core/http.js, line 149

Returns:

Promise resolving to an object with response details

Type: Promise.<{status:number, headers:object, body: *}>

(async) exec(method, path, query, body, headers) → {Promise.<{status:number, headers:object, body: *}>}

execute http request.

Parameters:

Name	Type	Description
`method`	string	method
`path`	string	request path
`query`	object	request query data
`body`	string \| object	request body
`headers`	object	header name and value object

Source:

core/http.js, line 164

Returns:

Promise resolving to an object with response details

Type: Promise.<{status:number, headers:object, body: *}>

(async) exec(method, path, query, body, headers) → {Promise.<{status:number, headers:object, body: *}>}

execute http request.

Parameters:

Name	Type	Description
`method`	string	method
`path`	string	request path
`query`	object	request query data
`body`	string \| object	request body
`headers`	object	header name and value object

Source:

core/http.js, line 164

Returns:

Promise resolving to an object with response details

Type: Promise.<{status:number, headers:object, body: *}>

get(path, ctxopt) → {Promise.<{status:number, headers:object, body: *}>}

do GET request.

Parameters:

Name Type Attributes Description

path String request path

ctx

object

context

Properties

Name	Type	Attributes	Description
`query`	object	<optional>	request query data
`body`	object	<optional>	request body
`headers`	object	<optional>	header name and value object

Source:

core/http.js, line 89

Returns:

Promise resolving to an object with response details

Type: Promise.<{status:number, headers:object, body: *}>

get(path, ctxopt) → {Promise.<{status:number, headers:object, body: *}>}

do GET request.

Parameters:

Name Type Attributes Description

path String request path

ctx

object

context

Properties

Name	Type	Attributes	Description
`query`	object	<optional>	request query data
`body`	object	<optional>	request body
`headers`	object	<optional>	header name and value object

Source:

core/http.js, line 89

Returns:

Promise resolving to an object with response details

Type: Promise.<{status:number, headers:object, body: *}>

patch(path, ctxopt) → {Promise.<{status:number, headers:object, body: *}>}

do PATCH request.

Parameters:

Name Type Attributes Description

path String request path

ctx

object

context

Properties

Name	Type	Attributes	Description
`query`	object	<optional>	request query data
`body`	object	<optional>	request body
`headers`	object	<optional>	header name and value object

Source:

core/http.js, line 134

Returns:

Promise resolving to an object with response details

Type: Promise.<{status:number, headers:object, body: *}>

patch(path, ctxopt) → {Promise.<{status:number, headers:object, body: *}>}

do PATCH request.

Parameters:

Name Type Attributes Description

path String request path

ctx

object

context

Properties

Name	Type	Attributes	Description
`query`	object	<optional>	request query data
`body`	object	<optional>	request body
`headers`	object	<optional>	header name and value object

Source:

core/http.js, line 134

Returns:

Promise resolving to an object with response details

Type: Promise.<{status:number, headers:object, body: *}>

post(path, ctxopt) → {Promise.<{status:number, headers:object, body: *}>}

do POST request.

Parameters:

Name Type Attributes Description

path String request path

ctx

object

context

Properties

Name	Type	Attributes	Description
`query`	object	<optional>	request query data
`body`	object	<optional>	request body
`headers`	object	<optional>	header name and value object

Source:

core/http.js, line 104

Returns:

Promise resolving to an object with response details

Type: Promise.<{status:number, headers:object, body: *}>

post(path, ctxopt) → {Promise.<{status:number, headers:object, body: *}>}

do POST request.

Parameters:

Name Type Attributes Description

path String request path

ctx

object

context

Properties

Name	Type	Attributes	Description
`query`	object	<optional>	request query data
`body`	object	<optional>	request body
`headers`	object	<optional>	header name and value object

Source:

core/http.js, line 104

Returns:

Promise resolving to an object with response details

Type: Promise.<{status:number, headers:object, body: *}>

put(path, ctxopt) → {Promise.<{status:number, headers:object, body: *}>}

do PUT request.

Parameters:

Name Type Attributes Description

path String request path

ctx

object

context

Properties

Name	Type	Attributes	Description
`query`	object	<optional>	request query data
`body`	object	<optional>	request body
`headers`	object	<optional>	header name and value object

Source:

core/http.js, line 119

Returns:

Promise resolving to an object with response details

Type: Promise.<{status:number, headers:object, body: *}>

put(path, ctxopt) → {Promise.<{status:number, headers:object, body: *}>}

do PUT request.

Parameters:

Name Type Attributes Description

path String request path

ctx

object

context

Properties

Name	Type	Attributes	Description
`query`	object	<optional>	request query data
`body`	object	<optional>	request body
`headers`	object	<optional>	header name and value object

Source:

core/http.js, line 119

Returns:

Promise resolving to an object with response details

Type: Promise.<{status:number, headers:object, body: *}>

HttpClient()

new HttpClient()

HTTP Client

Source:

core/http.js, line 33

Classes

HttpClient
HttpClient

Methods

(async) beforeError(err) → {Promise.<boolean>}

hook async function called before throw an error.

Parameters:

Name	Type	Description
`err`	HttpError	request path

Source:

core/http.js, line 75

Returns:

- if return false, stop throwing the error.

Type: Promise.<boolean>

(async) beforeError(err) → {Promise.<boolean>}

hook async function called before throw an error.

Parameters:

Name	Type	Description
`err`	HttpError	request path

Source:

core/http.js, line 75

Returns:

- if return false, stop throwing the error.

Type: Promise.<boolean>

(async) beforeRequest(path, ctxopt)

hook async function called before the request.

Parameters:

Name Type Attributes Description

path String request path

ctx

object

context

Properties

Name	Type	Attributes	Description
`query`	object	<optional>	request query data
`body`	object	<optional>	request body
`headers`	object	<optional>	header name and value object

Source:

core/http.js, line 67

(async) beforeRequest(path, ctxopt)

hook async function called before the request.

Parameters:

Name Type Attributes Description

path String request path

ctx

object

context

Properties

Name	Type	Attributes	Description
`query`	object	<optional>	request query data
`body`	object	<optional>	request body
`headers`	object	<optional>	header name and value object

Source:

core/http.js, line 67

delete(path, ctxopt) → {Promise.<{status:number, headers:object, body: *}>}

do DELETE request.

Parameters:

Name Type Attributes Description

path String request path

ctx

object

context

Properties

Name	Type	Attributes	Description
`query`	object	<optional>	request query data
`body`	object	<optional>	request body
`headers`	object	<optional>	header name and value object

Source:

core/http.js, line 149

Returns:

Promise resolving to an object with response details

Type: Promise.<{status:number, headers:object, body: *}>

delete(path, ctxopt) → {Promise.<{status:number, headers:object, body: *}>}

do DELETE request.

Parameters:

Name Type Attributes Description

path String request path

ctx

object

context

Properties

Name	Type	Attributes	Description
`query`	object	<optional>	request query data
`body`	object	<optional>	request body
`headers`	object	<optional>	header name and value object

Source:

core/http.js, line 149

Returns:

Promise resolving to an object with response details

Type: Promise.<{status:number, headers:object, body: *}>

(async) exec(method, path, query, body, headers) → {Promise.<{status:number, headers:object, body: *}>}

execute http request.

Parameters:

Name	Type	Description
`method`	string	method
`path`	string	request path
`query`	object	request query data
`body`	string \| object	request body
`headers`	object	header name and value object

Source:

core/http.js, line 164

Returns:

Promise resolving to an object with response details

Type: Promise.<{status:number, headers:object, body: *}>

(async) exec(method, path, query, body, headers) → {Promise.<{status:number, headers:object, body: *}>}

execute http request.

Parameters:

Name	Type	Description
`method`	string	method
`path`	string	request path
`query`	object	request query data
`body`	string \| object	request body
`headers`	object	header name and value object

Source:

core/http.js, line 164

Returns:

Promise resolving to an object with response details

Type: Promise.<{status:number, headers:object, body: *}>

get(path, ctxopt) → {Promise.<{status:number, headers:object, body: *}>}

do GET request.

Parameters:

Name Type Attributes Description

path String request path

ctx

object

context

Properties

Name	Type	Attributes	Description
`query`	object	<optional>	request query data
`body`	object	<optional>	request body
`headers`	object	<optional>	header name and value object

Source:

core/http.js, line 89

Returns:

Promise resolving to an object with response details

Type: Promise.<{status:number, headers:object, body: *}>

get(path, ctxopt) → {Promise.<{status:number, headers:object, body: *}>}

do GET request.

Parameters:

Name Type Attributes Description

path String request path

ctx

object

context

Properties

Name	Type	Attributes	Description
`query`	object	<optional>	request query data
`body`	object	<optional>	request body
`headers`	object	<optional>	header name and value object

Source:

core/http.js, line 89

Returns:

Promise resolving to an object with response details

Type: Promise.<{status:number, headers:object, body: *}>

patch(path, ctxopt) → {Promise.<{status:number, headers:object, body: *}>}

do PATCH request.

Parameters:

Name Type Attributes Description

path String request path

ctx

object

context

Properties

Name	Type	Attributes	Description
`query`	object	<optional>	request query data
`body`	object	<optional>	request body
`headers`	object	<optional>	header name and value object

Source:

core/http.js, line 134

Returns:

Promise resolving to an object with response details

Type: Promise.<{status:number, headers:object, body: *}>

patch(path, ctxopt) → {Promise.<{status:number, headers:object, body: *}>}

do PATCH request.

Parameters:

Name Type Attributes Description

path String request path

ctx

object

context

Properties

Name	Type	Attributes	Description
`query`	object	<optional>	request query data
`body`	object	<optional>	request body
`headers`	object	<optional>	header name and value object

Source:

core/http.js, line 134

Returns:

Promise resolving to an object with response details

Type: Promise.<{status:number, headers:object, body: *}>

post(path, ctxopt) → {Promise.<{status:number, headers:object, body: *}>}

do POST request.

Parameters:

Name Type Attributes Description

path String request path

ctx

object

context

Properties

Name	Type	Attributes	Description
`query`	object	<optional>	request query data
`body`	object	<optional>	request body
`headers`	object	<optional>	header name and value object

Source:

core/http.js, line 104

Returns:

Promise resolving to an object with response details

Type: Promise.<{status:number, headers:object, body: *}>

post(path, ctxopt) → {Promise.<{status:number, headers:object, body: *}>}

do POST request.

Parameters:

Name Type Attributes Description

path String request path

ctx

object

context

Properties

Name	Type	Attributes	Description
`query`	object	<optional>	request query data
`body`	object	<optional>	request body
`headers`	object	<optional>	header name and value object

Source:

core/http.js, line 104

Returns:

Promise resolving to an object with response details

Type: Promise.<{status:number, headers:object, body: *}>

put(path, ctxopt) → {Promise.<{status:number, headers:object, body: *}>}

do PUT request.

Parameters:

Name Type Attributes Description

path String request path

ctx

object

context

Properties

Name	Type	Attributes	Description
`query`	object	<optional>	request query data
`body`	object	<optional>	request body
`headers`	object	<optional>	header name and value object

Source:

core/http.js, line 119

Returns:

Promise resolving to an object with response details

Type: Promise.<{status:number, headers:object, body: *}>

put(path, ctxopt) → {Promise.<{status:number, headers:object, body: *}>}

do PUT request.

Parameters:

Name Type Attributes Description

path String request path

ctx

object

context

Properties

Name	Type	Attributes	Description
`query`	object	<optional>	request query data
`body`	object	<optional>	request body
`headers`	object	<optional>	header name and value object

Source:

core/http.js, line 119

Returns:

Promise resolving to an object with response details

Type: Promise.<{status:number, headers:object, body: *}>