matrix/matrix-js-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-js-sdk.git synced 2025-09-12 04:51:50 +03:00
Code Activity

Add missing jsdoc.

Browse Source
This commit is contained in:
Kegan Dougal
2015-06-03 16:18:22 +01:00
parent 3dad5ad913
commit 5a16986014
2 changed files with 48 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
dist/browser-matrix-dev.js vendored
View File

@@ -12,6 +12,10 @@ TODO:
// expose the underlying request object so different environments can use
// different request libs (e.g. request or browser-request)
var request;
/**
* The function used to perform HTTP requests.
* @param {Function} r The request function which accepts (opts, callback)
*/
module.exports.request = function(r) {
request = r;
};
@@ -50,7 +54,18 @@ function MatrixClient(credentials, config, store) {
this.fromToken = undefined;
this.clientRunning = false;
}
/**
* The high-level Matrix Client class.
*/
module.exports.MatrixClient = MatrixClient; // expose the class
/**
* Create a new Matrix Client.
* @param {Object} credentials The Matrix credentials to use.
* @param {Object} config The config options for the client
* @param {Store} store The type of store to use.
* @return {MatrixClient} A new Matrix Client
*/
module.exports.createClient = function(credentials, config, store) {
return new MatrixClient(credentials, config, store);
};
@@ -72,6 +87,10 @@ var HEADERS = {
function MatrixEvent(event) {
this.event = event || {};
}
/**
* An event from Matrix.
*/
module.exports.MatrixEvent = MatrixEvent;
MatrixEvent.prototype = {
@@ -108,6 +127,10 @@ function MatrixInMemoryStore() {
// presence objects keyed by userId
};
}
/**
* An in-memory store for Matrix.
*/
module.exports.MatrixInMemoryStore = MatrixInMemoryStore;
// XXX: this is currently quite procedural - we could possibly pass back
@@ -1096,6 +1119,7 @@ var map = function(array, fn) {
}
return results;
};
},{}],2:[function(require,module,exports){
// Browser Request
//

25
lib/matrix.js
View File

@@ -11,6 +11,10 @@ TODO:
// expose the underlying request object so different environments can use
// different request libs (e.g. request or browser-request)
var request;
/**
* The function used to perform HTTP requests.
* @param {Function} r The request function which accepts (opts, callback)
*/
module.exports.request = function(r) {
request = r;
};
@@ -49,7 +53,18 @@ function MatrixClient(credentials, config, store) {
this.fromToken = undefined;
this.clientRunning = false;
}
/**
* The high-level Matrix Client class.
*/
module.exports.MatrixClient = MatrixClient; // expose the class
/**
* Create a new Matrix Client.
* @param {Object} credentials The Matrix credentials to use.
* @param {Object} config The config options for the client
* @param {Store} store The type of store to use.
* @return {MatrixClient} A new Matrix Client
*/
module.exports.createClient = function(credentials, config, store) {
return new MatrixClient(credentials, config, store);
};
@@ -71,6 +86,10 @@ var HEADERS = {
function MatrixEvent(event) {
this.event = event || {};
}
/**
* An event from Matrix.
*/
module.exports.MatrixEvent = MatrixEvent;
MatrixEvent.prototype = {
@@ -107,6 +126,10 @@ function MatrixInMemoryStore() {
// presence objects keyed by userId
};
}
/**
* An in-memory store for Matrix.
*/
module.exports.MatrixInMemoryStore = MatrixInMemoryStore;
// XXX: this is currently quite procedural - we could possibly pass back
@@ -1094,4 +1117,4 @@ var map = function(array, fn) {
results[i] = fn(array[i]);
}
return results;
};
};