Skip to content

Commit 8922d97

Browse files
committed
[ Add ] API document based on ESDoc
1 parent 0ba9303 commit 8922d97

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+26758
-16
lines changed

.esdoc.json

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"source": "./source",
3+
"destination": "./docs",
4+
"plugins": [
5+
{
6+
"name": "esdoc-standard-plugin",
7+
"option": {
8+
"test": {
9+
"source": "./test",
10+
"interfaces": ["describe", "it"],
11+
"includes": ["\\.js$"]
12+
}
13+
}
14+
},
15+
{
16+
"name": "esdoc-ecmascript-proposal-plugin",
17+
"option": {
18+
"all": true
19+
}
20+
},
21+
{
22+
"name": "esdoc-external-webapi-plugin",
23+
"option": {
24+
"enable": true
25+
}
26+
}
27+
]
28+
}

dist/WaterWheel.js

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -333,8 +333,27 @@ var _module_ = {
333333
Object.defineProperty(exports, "__esModule", {
334334
value: true
335335
});
336+
exports.default = request;
336337

337-
exports.default = function (URL, method, data, type) {
338+
var _EventStream = require('./EventStream');
339+
340+
var _EventStream2 = _interopRequireDefault(_EventStream);
341+
342+
function _interopRequireDefault(obj) {
343+
return obj && obj.__esModule ? obj : { default: obj };
344+
}
345+
346+
/**
347+
* HTTP request
348+
*
349+
* @param {string|URL} URL
350+
* @param {string} [method='GET']
351+
* @param {?*} data - Data to send
352+
* @param {string} [type='text'] - [Response type](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType)
353+
*
354+
* @return {EventSource}
355+
*/
356+
function request(URL, method, data, type) {
338357

339358
return new _EventStream2.default(function (next, done, fail) {
340359

@@ -361,14 +380,6 @@ var _module_ = {
361380

362381
XHR.send(data);
363382
});
364-
};
365-
366-
var _EventStream = require('./EventStream');
367-
368-
var _EventStream2 = _interopRequireDefault(_EventStream);
369-
370-
function _interopRequireDefault(obj) {
371-
return obj && obj.__esModule ? obj : { default: obj };
372383
}
373384
}
374385
}

dist/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import EventStream from './EventStream';
1010
*
1111
* @return {EventSource}
1212
*/
13-
export default function (URL, method, data, type) {
13+
export default function request(URL, method, data, type) {
1414

1515
return new EventStream((next, done, fail) => {
1616

0 commit comments

Comments
 (0)