Class: request

Classes

poll

Methods

addInterceptor(interceptorFn){LuCI.request.interceptorFn}

luci.js, line 895

Register an HTTP response interceptor function. Interceptor functions are useful to perform default actions on incoming HTTP responses, such as checking for expired authentication or for implementing request retries before returning a failure.

Name	Type	Description
interceptorFn	LuCI.request.interceptorFn	The interceptor function to register.

Returns:

Type	Description
LuCI.request.interceptorFn	The registered function.

expandURL(url){string}

luci.js, line 630

Turn the given relative URL into an absolute URL if necessary.

Name	Type	Description
url	string	The URL to convert.

Returns:

Type	Description
string	The absolute URL derived from the given one, or the original URL if it already was absolute.

get(url, options){Promise.<LuCI.response>}

luci.js, line 848

Initiate an HTTP GET request to the given target.

Name	Type	Description
url	string	The URL to request.
options	LuCI.request.RequestOptions	optional Additional options to configure the request.

Returns:

Type	Description
Promise.<LuCI.response>	The resulting HTTP response.

post(url, data, options){Promise.<LuCI.response>}

luci.js, line 869

Initiate an HTTP POST request to the given target.

Name	Type	Description
url	string	The URL to request.
data	*	optional The request data to send, see LuCI.request.RequestOptions for details.
options	LuCI.request.RequestOptions	optional Additional options to configure the request.

Returns:

Type	Description
Promise.<LuCI.response>	The resulting HTTP response.

removeInterceptor(interceptorFn){boolean}

luci.js, line 914

Remove an HTTP response interceptor function. The passed function value must be the very same value that was used to register the function.

Name	Type	Description
interceptorFn	LuCI.request.interceptorFn	The interceptor function to remove.

Returns:

Type	Description
boolean	Returns true if any function has been removed, else false.

request(target, options){Promise.<LuCI.response>}

luci.js, line 697

Initiate an HTTP request to the given target.

Name	Type	Description
target	string	The URL to request.
options	LuCI.request.RequestOptions	optional Additional options to configure the request.

Returns:

Type	Description
Promise.<LuCI.response>	The resulting HTTP response.

Type Definitions

LuCI.request.interceptorFn(res)

luci.js, line 873

Interceptor functions are invoked whenever an HTTP reply is received, in the order these functions have been registered.

Name	Type	Description
res	LuCI.response	The HTTP response object

LuCI.request.RequestOptionsObject

Properties:

Name	Type	Argument	Default	Description
method	string	<optional>	GET	The HTTP method to use, e.g. GET or POST.
query	Object.<string, (Object|string)>	<optional>		Query string data to append to the URL. Non-string values of the given object will be converted to JSON.
cache	boolean	<optional>	false	Specifies whether the HTTP response may be retrieved from cache.
username	string	<optional>		Provides a username for HTTP basic authentication.
password	string	<optional>		Provides a password for HTTP basic authentication.
timeout	number	<optional>		Specifies the request timeout in milliseconds.
credentials	boolean	<optional>	false	Whether to include credentials such as cookies in the request.
responseType	string	<optional>	text	Overrides the request response type. Valid values or text to interpret the response as UTF-8 string or blob to handle the response as binary Blob data.
content	*	<optional>		Specifies the HTTP message body to send along with the request. If the value is a function, it is invoked and the return value used as content, if it is a FormData instance, it is used as-is, if it is an object, it will be converted to JSON, in all other cases it is converted to a string.
header	Object.<string, string>	<optional>		Specifies HTTP headers to set for the request.
progress	function	<optional>		An optional request callback function which receives ProgressEvent instances as sole argument during the HTTP request transfer.