class vaseClient::HttpReq

sys::Obj
  vaseClient::HttpReq

@Js

HttpReq models the request side of an XMLHttpRequest instance.

See pod doc for details.

decoder

Func<Obj?,InStream>? decoder

get

Promise<HttpRes> get()

Convenience for send("GET", "", c).

headers

Map<Str,Str> headers := Map<Str,Str>[:]

The request headers to send.

make

new make(Func<Void,This>? f := null)

Create a new HttpReq instance.

onProgress

Void onProgress(Func<Void,Int,Int> f)

Optional callback to track progress of request transfers, where loaded is the number of bytes that have been transferred, and total is the total number of bytes to be transferred.

For GET requests, the progress will track the response being downloaded to the browser. For PUT and POST requests, the progress will track the content being uploaded to the server.

Note this callback is only invoked when lengthComputable is true on the underlying progress events.

post

Promise<HttpRes> post(Obj content)

Convenience for send("POST", content, c).

postForm

Promise<HttpRes> postForm(Map<Str,Str> form)

Post the form map as a HTML form submission. Formats the map into a valid url-encoded content string, and sets Content-Type header to application/x-www-form-urlencoded.

postMultipart

Promise<HttpRes> postMultipart(Map<Str,Obj> form)

Post by multipart protocol. The form value is Str or File type.

send

Promise<HttpRes> send(Str method, Obj? content)

Send a request with the given content using the given HTTP method (case does not matter). After receiving the response, call the given closure with the resulting HttpRes object.

timeout

Int timeout := 10000

uri

Uri uri := `#`

The Uri to send the request.

useCache

Bool useCache := false

invalide in JS runtime

withCredentials

Bool withCredentials := false

Indicates whether or not cross-site Access-Control requests should be made using credentials such as cookies, authorization headers or TLS client certificates. Setting withCredentials has no effect on same-site requests. The default is false.

Requests from a different domain cannot set cookie values for their own domain unless withCredentials is set to true before making the request. The third-party cookies obtained by setting withCredentials to true will still honor same-origin policy and hence can not be accessed by the requesting script through Doc.cookies or from response headers.