Constructor
new XHttpClient(host, ratePerMinuteopt)
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
host |
String | Server host address | |
ratePerMinute |
Number |
<optional> |
Maximum requests allowed per minute (default 300) |
Members
interceptors :Object
- Source:
Interceptors
Type:
- Object
Methods
send(ajax)
- Source:
Add ajax request to queue
Parameters:
| Name | Type | Description |
|---|---|---|
ajax |
Ajax |
get(route, paramsopt, headersopt, responseTypeopt, cancelTokenopt) → {Promise.<Ajax>}
- Source:
Equeue http GET request
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
route |
String | request route - appends to host address | |
params |
Object |
<optional> |
request params(args) |
headers |
Object |
<optional> |
request headers |
responseType |
String |
<optional> |
"text"|"json"|"xml"|"document"|"arraybuffer"|"blob"|"ms-stream"|"" |
cancelToken |
String |
<optional> |
A token used to cancel a group of requests |
Returns:
- Type
- Promise.<Ajax>
post(route, paramsopt, headersopt, contentopt, responseTypeopt, cancelTokenopt) → {Promise.<Ajax>}
- Source:
Equeue http POST request
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
route |
String | request route - appends to host address | |
params |
Object |
<optional> |
request params(args) |
headers |
Object |
<optional> |
request headers |
content |
http.HttpContent |
<optional> |
request content. example: {type:'json', data={count: 13}} |
responseType |
String |
<optional> |
"text"|"json"|"xml"|"document"|"arraybuffer"|"blob"|"ms-stream"|"" |
cancelToken |
String |
<optional> |
A token used to cancel a group of requests |
Returns:
- Type
- Promise.<Ajax>
put(route, paramsopt, headersopt, contentopt, responseTypeopt, cancelTokenopt) → {Promise.<Ajax>}
- Source:
Equeue http PUT request
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
route |
String | request route - appends to host address | |
params |
Object |
<optional> |
request params(args) |
headers |
Object |
<optional> |
request headers |
content |
http.HttpContent |
<optional> |
request content. example: {type:'json', data={count: 13}} |
responseType |
String |
<optional> |
"text"|"json"|"xml"|"document"|"arraybuffer"|"blob"|"ms-stream"|"" |
cancelToken |
String |
<optional> |
A token used to cancel a group of requests |
Returns:
- Type
- Promise.<Ajax>
patch(route, paramsopt, headersopt, contentopt, responseTypeopt, cancelTokenopt) → {Promise.<Ajax>}
- Source:
Equeue http PATCH request
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
route |
String | request route - appends to host address | |
params |
Object |
<optional> |
request params(args) |
headers |
Object |
<optional> |
request headers |
content |
http.HttpContent |
<optional> |
request content. example: {type:'json', data={count: 13}} |
responseType |
String |
<optional> |
"text"|"json"|"xml"|"document"|"arraybuffer"|"blob"|"ms-stream"|"" |
cancelToken |
String |
<optional> |
A token used to cancel a group of requests |
Returns:
- Type
- Promise.<Ajax>
delete(route, paramsopt, headersopt, contentopt, responseTypeopt, cancelTokenopt) → {Promise.<Ajax>}
- Source:
Equeue http DELETE request
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
route |
String | request route - appends to host address | |
params |
Object |
<optional> |
request params(args) |
headers |
Object |
<optional> |
request headers |
content |
http.HttpContent |
<optional> |
request content. example: {type:'json', data={count: 13}} |
responseType |
String |
<optional> |
"text"|"json"|"xml"|"document"|"arraybuffer"|"blob"|"ms-stream"|"" |
cancelToken |
String |
<optional> |
A token used to cancel a group of requests |
Returns:
- Type
- Promise.<Ajax>
cancel(token)
- Source:
Cancel all requests(sending or enqueued) with given token
Parameters:
| Name | Type | Description |
|---|---|---|
token |
String |