Phaser API Documentation

  Version: 
XHRSettingsObject
Properties:
name type arguments Default description
responseType XMLHttpRequestResponseType

The response type of the XHR request, i.e. blob, text, etc.

async boolean <optional> true

Should the XHR request use async or not?

user string <optional> ''

Optional username for the XHR request.

password string <optional> ''

Optional password for the XHR request.

timeout number <optional> 0

Optional XHR timeout value.

headers object | undefined <optional>

This value is used to populate the XHR setRequestHeader and is undefined by default.

header string | undefined <optional>

This value is used to populate the XHR setRequestHeader and is undefined by default.

headerValue string | undefined <optional>

This value is used to populate the XHR setRequestHeader and is undefined by default.

requestedWith string | undefined <optional>

This value is used to populate the XHR setRequestHeader and is undefined by default.

overrideMimeType string | undefined <optional>

Provide a custom mime-type to use instead of the default.

withCredentials boolean <optional> false

The withCredentials property 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.

Type:
object
Since: 3.0.0