From 89a50c2f8f45a4d5a1bfbc2eb8e29e5836feeccb Mon Sep 17 00:00:00 2001 From: Jo-Philipp Wich Date: Thu, 2 Apr 2020 21:50:07 +0200 Subject: docs: update js api docs Signed-off-by: Jo-Philipp Wich --- docs/jsapi/LuCI.Response.html | 2577 ----------------------------------------- 1 file changed, 2577 deletions(-) delete mode 100644 docs/jsapi/LuCI.Response.html (limited to 'docs/jsapi/LuCI.Response.html') diff --git a/docs/jsapi/LuCI.Response.html b/docs/jsapi/LuCI.Response.html deleted file mode 100644 index a861348b3..000000000 --- a/docs/jsapi/LuCI.Response.html +++ /dev/null @@ -1,2577 +0,0 @@ - - - - - Class: Response - - - - - - - - - - - - - - - - - -
- - -
-

Class: Response

- - - - -
- -
-

- LuCI. - - Response -

- -

The Response class is an internal utility class representing HTTP responses.

- -
- -
-
- - - - -
-
-

- - new LuCI.Response() -

- - - - -
- - -
-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - -
- - - - - - - - - - - - -

Members

- -
- -
-
-

durationnumber

-
- - -
-
- -
-

The total duration of the HTTP request in milliseconds

-
- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - -
-
-

headersLuCI.Headers

-
- - -
-
- -
-

The HTTP headers of the response

-
- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - -
-
-

okboolean

-
- - -
-
- -
-

Describes whether the response is successful (status codes 200..299) or not

-
- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - -
-
-

statusnumber

-
- - -
-
- -
-

The numeric HTTP status code of the response

-
- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - -
-
-

statusTextstring

-
- - -
-
- -
-

The HTTP status description message of the response

-
- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - -
-
-

urlstring

-
- - -
-
- -
-

The final URL of the request, i.e. after following redirects.

-
- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - -
- -
- - - -

Methods

- -
- -
-
-

- - blob(){Blob} -

- - - - -
- - -
-
- - -
-

Access the response content as blob.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - Blob - - - The response content as blob.
- - - - -
- - - -
-
-

- - clone(content){LuCI.Response} -

- - - - -
- - -
-
- - -
-

Clones the given response object, optionally overriding the content -of the cloned instance.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
content - - -* - - - - - - - optional - - - - - -

Override the content of the cloned response. Object values will be -treated as JSON response data, all other types will be converted -using String() and treated as response text.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - LuCI.Response - - - The cloned Response instance.
- - - - -
- - - -
-
-

- - json(){*} -

- - - - -
- - -
-
- - -
-

Access the response content as JSON data.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - -
Throws:
- - - -
-
-
-

Throws SyntaxError if the content isn't valid JSON.

-
-
-
-
-
- Type -
-
- -SyntaxError - - -
-
-
-
- - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - * - - - The parsed JSON data.
- - - - -
- - - -
-
-

- - text(){string} -

- - - - -
- - -
-
- - -
-

Access the response content as string.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - string - - - The response content.
- - - - -
- -
- - - - - - - -
- -
- - - - - - - -
- Documentation generated by JSDoc 3.6.3 on Tue Mar 31 2020 21:30:33 GMT+0200 (Central European Summer Time) -
-
-
- - - - \ No newline at end of file -- cgit v1.2.3