matrix/matrix-js-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-js-sdk.git synced 2025-11-28 05:03:59 +03:00
Code Activity

Add @module docs. Remove browser-build.sh

Browse Source 
Add @links for HTML output. Replace browser-build.sh with inline commands
in package.json so building will work on non-unix machines. Update README.
This commit is contained in:
Kegan Dougal
2015-06-04 16:34:00 +01:00
parent 31ffdf8a37
commit 7ab3e25218
9 changed files with 63 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
lib/http-api.js
View File

@@ -1,4 +1,8 @@
"use strict";
/**
* This is an internal module. See {@link MatrixHttpApi} for the public class.
* @module http-api
*/
var utils = require("./utils");
@@ -15,7 +19,7 @@ TODO:
module.exports.PREFIX_V1 = "/_matrix/client/api/v1";
/**
* A constant representing the URI path for version 2 Alpha of the Client-Server
* A constant representing the URI path for version 2 alpha of the Client-Server
* HTTP API.
*/
module.exports.PREFIX_V2_ALPHA_PREFIX = "/_matrix/client/v2_alpha";
@@ -40,12 +44,12 @@ var HEADERS = {
* @param {string} opts.accessToken The access_token to send with requests. Can be
* null to not send an access token.
*/
function MatrixHttpApi(opts) {
module.exports.MatrixHttpApi = function MatrixHttpApi(opts) {
utils.checkObjectHasKeys(opts, ["baseUrl", "request", "prefix"]);
this.opts = opts;
}
};
MatrixHttpApi.prototype = {
module.exports.MatrixHttpApi.prototype = {
// URI functions
// =============
@@ -192,10 +196,3 @@ var requestCallback = function(userDefinedCallback) {
}
};
};
/**
* The Matrix HTTP API class.
*/
module.exports.MatrixHttpApi = MatrixHttpApi;