https://github.com/pandao/httpx.js
The simple HTTP / RESTful requests library of JavaScript (XHR).
https://github.com/pandao/httpx.js
Last synced: about 1 month ago
JSON representation
The simple HTTP / RESTful requests library of JavaScript (XHR).
- Host: GitHub
- URL: https://github.com/pandao/httpx.js
- Owner: pandao
- License: mit
- Created: 2015-06-15T17:06:26.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2019-01-24T03:38:27.000Z (over 6 years ago)
- Last Synced: 2024-10-29T21:54:07.481Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 38.1 KB
- Stars: 54
- Watchers: 6
- Forks: 26
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGE.md
- License: LICENSE
Awesome Lists containing this project
README
# httpx.js
The simple HTTP / RESTful requests library of JavaScript (XHR).
> Basic support XHR1 (XMLHttpRequest Level 1), Promise and XHR2 (XMLHttpRequest Level 2) support later.
### Install
```shell
bower install httpx.js --save
# or
npm install httpx.js --save
```
### Methods
- GET
- POST
- PUT
- PATCH
- DELETE
- Other
- JSON `(alias getJSON)`
- JSONP
- getScript
### Compatibility
- Firefox 4.0+
- Chrome 7+
- IE 9+
- Opera 11.60+
- Safari 5.1.4+
### Examples
Description :
get|post|put|patch|delete|json(alias getJSON)(url, [data], [callback], [error], [options]);
GET :
```javascript
httpx.get("http://localhost/http-test/get.php?foo=Level1&bar=XHR&zh=中文", function(data) {
//console.log(data, this);
}, function(method, url) {
console.error("Custom Error", method, url, this.status, this.statusText);
});
```
POST :
```javascript
httpx.post("http://localhost/http-test/post.php?edfd=eedfd&dfsdf=ere", {
a : 12,
b : "bbbb",
c : 123489
}, function(data) {
console.log(data, this);
});
```
PUT :
```javascript
httpx.put("http://localhost/http-test/put.php?edfd=eedfd&dfsdf=ere", {
a : 12,
b : "bbbb",
c : 123489
}, function(data) {
console.log(data, this);
});
```
PATCH :
```javascript
httpx.patch("http://localhost/http-test/patch.php?edfd=eedfd&dfsdf=ere", {
a : 12,
b : "bbbb",
c : 123489
}, function(data) {
console.log(data, this);
});
```
DELETE :
```javascript
httpx.delete("http://localhost/http-test/delete.php?edfd=eedfd&dfsdf=ere", {
a : 12,
b : "bbbb",
c : 123489
}, function(data) {
console.log(data, this);
});
```
JSON (get json) :
```javascript
// Alias getJSON(), like jQuery
httpx.json("http://localhost/http-test/get-json.php?temp="+(new Date).getTime(), {
test : 123
}, function(json) {
console.log("get json =>", json);
});
```
JSONP :
jsonp(url, [data], [callback], [callbackName]); // callbackName for query string name
```javascript
httpx.jsonp("http://192.168.1.2/http-test/jsonp.php?temp="+(new Date).getTime(), {
test : 123
}, function(json) {
console.log("jsonp =>", json);
}, "callback");
```
getScript :
```javascript
httpx.getScript("http://192.168.1.2/http-test/test.js", function() {
test();
});
```
### Options
defaults :
```javascript
{
debug : false,
async : true,
timeout : 3000,
method : "GET",
url : "",
data : "",
dataType : "text",
headers : {},
contentType : "text/plain; charset=UTF-8",
jsonp : "callback", // for query string
xhrFields : { // like jQuery xhrFields options
withCredentials : false
},
sendBefore : function(xhr) {
return xhr; // or return this, this == xhr
},
success : function() {},
error : function(method, url) {},
ontimeout : function(method, url) {}
}
```
usage :
```javascript
httpx.request({
url : "http://localhost/http-test/head.php",
method : "HEAD", // Custom http method
headers : {}, // Custom http headers
success : function(data) {
console.log(data, this, this.$request);
}
});
httpx.get({
url : "http://localhost/http-test/get.php?foo=bar",
headers : {
"xxxxxxx" : "xxxxx"
},
success : function(data) {
console.log(data, this, this.$request);
}
});
httpx.post({
url : "http://localhost/http-test/post.php?foo=bar",
data : {
id : 123,
title : "xxxxx"
},
headers : {
"xxxxxxx" : "xxxxx"
},
success : function(data) {
console.log(data, this, this.$request);
}
});
// put/patch/delete/json ...
```
### Development
```bash
# init
npm install
# develop
gulp watch
# or npm run dev
# production
gulp build
# or npm run build
```
### Changes
[Change logs](https://github.com/pandao/httpx.js/blob/master/CHANGE.md)
### License
The [MIT License](https://github.com/pandao/httpx.js/blob/master/LICENSE).
Copyright (c) 2015~2017 Pandao