Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rubylouvre/mmrequest
avalon王之三柱臣 之一
https://github.com/rubylouvre/mmrequest
Last synced: about 2 months ago
JSON representation
avalon王之三柱臣 之一
- Host: GitHub
- URL: https://github.com/rubylouvre/mmrequest
- Owner: RubyLouvre
- Created: 2013-10-14T11:10:01.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2016-08-25T07:21:58.000Z (over 8 years ago)
- Last Synced: 2024-11-11T14:21:25.494Z (about 2 months ago)
- Language: JavaScript
- Size: 1.03 MB
- Stars: 43
- Watchers: 7
- Forks: 34
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
mmRequest
=========
mmRequest 为异步 HTTP（AJAX）请求提供了解决方案。就像 `jQuery.ajax()` 所做的那样。
mmRequest 是 avalon 三柱臣之一（另外两个是 route 和 animation）。
安装
------------
从 [bower](http://bower.io/) 安装：
```
bower install mm-request
```
从npm 安装
```
npm install mmRequest --save
```
开始
------------
Avalon 遵循 [AMD](https://github.com/amdjs/amdjs-api) 规范。在引入 `avalon.js` 和 `mmRequest.js` 之后，你便可以像下面这样使用 mmRequest 了：
```javascript
require(['./mmRequest'], function(avalon) {
avalon.ajax({
url: '/foobar'
});
});
```
文档
-------------
mmRequest 提供了如下方法：
```javascript
/*
* avalon.ajax 需要传入一个拥有类似 url、type、dataType、type 等属性的对象参数；
* avalon.ajax 的行为类似于 jQuery.ajax。
*/
avalon.ajax(opts)
/*
* 其他一些简写方法：
*/
avalon.get( url [, data ] [, success(data, textStatus, XHR) ] [, dataType ] )
avalon.post( url [, data ] [, success(data, textStatus, XHR) ] [, dataType ] )
avalon.upload( url, form [,data] [, success(data, textStatus, XHR)] [, dataType])
avalon.getJSON( url [, data ] [, success( data, textStatus, jqXHR ) ] )
avalon.getScript( url [, success(script, textStatus, jqXHR) ] )
avalon可以在配置对象使用headers来指定头部,
```javascript
avalon.ajax({
type: "POST",
url: "your-path",
headers: {
xxx: "yyy"
},
success: function(){}
})
```
/*
* 一些有用的工具类方法：
*/
// 将一个对象转换成一个用于 URL 中传递请求参数的字符串
avalon.param(obj)
// 将一个用于 URL 中传递请求参数的字符串转换成一个对象
avalon.unparam(str)
// 将一个元素中的表单元素编码成字符串
avalon.serialize(element)
```
更多信息请参考 `/docs`。
示例
----
安装依赖：
```
cd demo/ && npm install
```
如果你很幸运地在中国，试试 [cnpm](http://cnpmjs.org/)。
开启服务：
```
cd ../ && npm start
```
现在，打开你的浏览器访问 `http://127.0.0.1:3000` 这个地址，你将会看到例子。你可以在 `demo/bin/www` 这个文件中配置端口。
在测试跨域请求之前，你需要模拟一个跨域的环境。你可以将这个项目复制到另外的路径并用另一个端口开启服务作为后端服务（这个例子中，后端服务的端口是 `9000`）。
祝你愉快。:grin:
贡献
------------
请在 `src/` 目录下开发相应的模块。
mmRequest 使用 [gulp](http://gulpjs.com/) 构建，请先安装依赖模块：
```
npm install
```
然后开启 `gulp`，监听 `src/` 下的变化并自动合并文件至 `public/`：
```
gulp
```
更新日志
------------
见 [CHANGELOG.md](CHANGELOG.md)