new RequestModule()
- Source:
Members
(static) READY_STATE_DONE :number
- Source:
- Default Value:
- 4
Downloading is done
Type:
- number
(static) READY_STATE_HEADERS_RECEIVED :number
- Source:
- Default Value:
- 2
send() has been called, and headers and status are available.
Type:
- number
(static) READY_STATE_LOADING :number
- Source:
- Default Value:
- 3
Downloading; responseText holds partial data.
Type:
- number
(static) READY_STATE_OPENED :number
- Source:
- Default Value:
- 1
open() has been called.
Type:
- number
(static) READY_STATE_UNSENT :number
- Source:
- Default Value:
- 0
Client has been created. open() not called yet.
Type:
- number
Methods
(static) ParamsParser(value, pattern, optsopt) → {Object.<string, string>}
Parameters:
Name | Type | Attributes | Description | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
value |
string | |||||||||||||||||||||||||||||||||||||||||||||||
pattern |
string | |||||||||||||||||||||||||||||||||||||||||||||||
opts |
object |
<optional> |
Properties
|
Returns:
- Type
- Object.<string, string>
async() → {RequestModule.RequestConfig.async}
- Source:
- See:
-
- RequestModule.RequestConfig
Returns:
- Type
- RequestModule.RequestConfig.async
async(status) → {RequestModule}
- Source:
Parameters:
Name | Type | Description |
---|---|---|
status |
boolean | enable/disable XMLHttpRequest async mode |
Returns:
- Type
- RequestModule
config() → {RequestModule.RequestConfig}
- Source:
Returns:
- Type
- RequestModule.RequestConfig
configurator(template) → {RequestModule}
- Source:
Parameters:
Name | Type | Description |
---|---|---|
template |
'multipart' | 'blob' | 'binary' | 'POST' | 'prepare-multipart' | 'retrieve-blob' | 'retrieve-binary-string' | 'prepare-post' | 'check-status-code' | 'ignore-status-code' | configuration name |
Returns:
- Type
- RequestModule
headers(name, value) → {RequestModule}
- Source:
set a new header
Parameters:
Name | Type | Description |
---|---|---|
name |
string | |
value |
string |
Returns:
- Type
- RequestModule
headers() → {string}
- Source:
Returns:
- Type
- string
method(status) → {RequestModule}
- Source:
Parameters:
Name | Type | Description |
---|---|---|
status |
string | XMLHttpRequest method name, default is |
Returns:
- Type
- RequestModule
method() → {RequestModule.RequestConfig.method}
- Source:
- See:
-
- RequestModule.RequestConfig
Returns:
- Type
- RequestModule.RequestConfig.method
open(methodopt, urlopt, asyncopt, timeoutopt) → {RequestModule}
- Source:
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
method |
string |
<optional> |
"GET"
|
|
url |
string |
<optional> |
||
async |
boolean |
<optional> |
||
timeout |
number |
<optional> |
request timeout in seconds |
Returns:
- Type
- RequestModule
readyState() → {RequestModule.readyStateType}
- Source:
Returns:
request() → {XMLHttpRequest}
- Source:
Returns:
- Type
- XMLHttpRequest
response(type) → {Promise.<RequestModule>}
- Source:
Parameters:
Name | Type | Description |
---|---|---|
type |
'request' |
Returns:
- Type
- Promise.<RequestModule>
response() → {XMLHttpRequest.response}
- Source:
Returns:
- Type
- XMLHttpRequest.response
response(type) → {HTMLElement}
- Source:
Parameters:
Name | Type | Description |
---|---|---|
type |
'document' |
Returns:
- Type
- HTMLElement
response(type) → {Promise.<string>}
- Source:
Parameters:
Name | Type | Description |
---|---|---|
type |
'text' | 'json' |
Returns:
- Type
- Promise.<string>
response(type) → {Promise.<ArrayBuffer>}
- Source:
Parameters:
Name | Type | Description |
---|---|---|
type |
'arraybuffer' |
Returns:
- Type
- Promise.<ArrayBuffer>
response(type, paramsopt) → {Promise.<Blob>}
- Source:
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
type |
'blob' | |||
params |
Object |
<optional> |
{type: 'application/octet-stream'}
|
Blob constructor's params |
Returns:
- Type
- Promise.<Blob>
send(dataopt, typeopt) → {RequestModule}
- Source:
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
data |
string | FormData | MediaStream |
<optional> |
''
|
|
type |
"asFormData" | "json" |
<optional> |
null
|
Returns:
- Type
- RequestModule
status() → {XMLHttpRequest.status}
- Source:
Returns:
- Type
- XMLHttpRequest.status
statusText() → {XMLHttpRequest.statusText}
- Source:
Returns:
- Type
- XMLHttpRequest.statusText
timeout(seconds) → {RequestModule}
- Source:
update XMLHttpRequest timeout in seconds
Parameters:
Name | Type | Description |
---|---|---|
seconds |
number | set 0 to unlimited |
Returns:
- Type
- RequestModule
timeout() → {number}
- Source:
current XMLHttpRequest timeout in seconds
Returns:
- Type
- number
url(url) → {RequestModule}
- Source:
Parameters:
Name | Type | Description |
---|---|---|
url |
string | setup the url that should be processed |
Returns:
- Type
- RequestModule
url() → {RequestModule.RequestConfig.url}
- Source:
- See:
-
- RequestModule.RequestConfig
Returns:
- Type
- RequestModule.RequestConfig.url
withCredentials(status) → {RequestModule}
- Source:
update XMLHttpRequest withCredentials flag
Parameters:
Name | Type | Description |
---|---|---|
status |
boolean |
Returns:
- Type
- RequestModule
withCredentials() → {boolean}
- Source:
current XMLHttpRequest withCredentials status
Returns:
- Type
- boolean
Type Definitions
readyStateType
- Source:
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
READY_STATE_UNSENT |
number |
<optional> |
0
|
|
READY_STATE_OPENED |
number |
<optional> |
1
|
|
READY_STATE_HEADERS_RECEIVED |
number |
<optional> |
2
|
|
READY_STATE_LOADING |
number |
<optional> |
3
|
|
READY_STATE_DONE |
number |
<optional> |
4
|
Type:
- object
RequestConfig
- Source:
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
method |
boolean |
<optional> |
"GET"
|
|
url |
boolean |
<optional> |
"#"
|
|
async |
boolean |
<optional> |
true
|
|
opened |
boolean |
<optional> |
false
|
|
isSent |
boolean |
<optional> |
false
|
|
isLoaded |
boolean |
<optional> |
false
|
|
isUploaded |
boolean |
<optional> |
false
|
|
ignoreStatusCode |
boolean |
<optional> |
false
|
Type:
- Object