Classes
Methods
addInterceptor(interceptorFn) → {LuCI.request.interceptorFn}
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. | The interceptor function to register. |
The registered function.
expandURL(url) → {string}
Turn the given relative URL into an absolute URL if necessary.
| Name | Type | Description |
|---|---|---|
url | string | The URL to convert. |
The absolute URL derived from the given one, or the original URL if it already was absolute.
- Type:
- string
get(url, optionsopt) → {Promise.<LuCI.response>}
Initiate an HTTP GET request to the given target.
| Name | Type | Attributes | Description |
|---|---|---|---|
url | string | The URL to request. | |
options | LuCI. | <optional> | Additional options to configure the request. |
The resulting HTTP response.
- Type:
- Promise.<LuCI.response>
handleReadyStateChange(resolveFn, rejectFn, evopt) → {void}
Handle XHR readyState changes for an in-flight request and resolve or reject the originating promise.
| Name | Type | Attributes | Description |
|---|---|---|---|
resolveFn | function | Callback invoked on success with the constructed | |
rejectFn | function | Callback invoked on failure or abort with an | |
ev | Event | <optional> | The XHR |
No return value; the function resolves or rejects the supplied callbacks.
- Type:
- void
post(url, dataopt, optionsopt) → {Promise.<LuCI.response>}
Initiate an HTTP POST request to the given target.
| Name | Type | Attributes | Description |
|---|---|---|---|
url | string | The URL to request. | |
data | * | <optional> | The request data to send, see |
options | LuCI. | <optional> | Additional options to configure the request. |
The resulting HTTP response.
- Type:
- Promise.<LuCI.response>
removeInterceptor(interceptorFn) → {boolean}
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. | The interceptor function to remove. |
Returns true if any function has been removed, else false.
- Type:
- boolean
request(target, optionsopt) → {Promise.<LuCI.response>}
Initiate an HTTP request to the given target.
| Name | Type | Attributes | Description |
|---|---|---|---|
target | string | The URL to request. | |
options | LuCI. | <optional> | Additional options to configure the request. |
The resulting HTTP response.
- Type:
- Promise.<LuCI.response>
Type Definitions
RequestOptions
- Object
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
method | string | <optional> | GET | The HTTP method to use, e.g. |
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 |
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. | |
responseProgress | function | <optional> | An optional request callback function which receives ProgressEvent instances as sole argument during the HTTP response transfer. |
interceptorFn(res)
Interceptor functions are invoked whenever an HTTP reply is received, in the order these functions have been registered.
| Name | Type | Description |
|---|---|---|
res | LuCI. | The HTTP response object |