Merge pull request #62 from killme2008/master

Added avosExpressCookieSession and avosExpressHttpsRedirect api docs

Author: killme2008

lib/cloud.js

@@ -1,4 +1,19 @@
-(function() {
+/**
+ * Cloud code only APIs.
+ * All of these APIs are not implemented in client sdk,
+ * we put them here to generate API docs.
+ */
+(function(root) {
+  root.AV = root.AV || {};
+  /**
+   * Contains all AV API classes and functions.
+   * @name AV
+   * @namespace
+   *
+   * Contains all AV API classes and functions.
+   */
+  var AV = root.AV;
+
   /*
    * @class A Request object that is passed into the afterDelete function.
    * <strong>Available in Cloud Code only.</strong>
@@ -214,4 +229,33 @@
     * @return {AV.Promise}  A promise that will be resolved with a AV.Cloud.HTTPResponse object when the request completes.
     */
    AV.Cloud.httpRequest = function(options) {};
-})()
+
+   /**
+    * @namespace
+    * Express middleware for AV.User session management through a signed browser cookie.
+    * This API is LeanCloud-specific, and not included in the original Express API.
+    * See <a href="https://leancloud.cn/docs/cloud_code_guide.html#处理用户登录和登出">Cloud Code Guide</a> for details.
+    * <br/><strong>Available in Cloud Code only</strong>.
+    * @param {String} options.cookie Optional.
+    *                 Standard cookie options for the LeanCloud user session cookie.
+    *                 For your application's security, we ignore the httpOnly, signed flags in cookie options,
+    *                 and always set these to true for the cookie generated by this middleware.
+    * @param {Boolean} options.fetchUser Optional,Default: false.
+	*                 Whether to fetch the full current LeanCloud user object on each request.
+    *                 Setting this to true results in one extra LeanCloud API request during each Express request. If you set this false,
+    *                 ACLs will still work when you query for objects the current user is allowed to see,
+    *                 but you cannot access any fields on the current user object (except id) until you manually call AV.User.current().fetch().
+    * @param {String} options.key Optional, Default: 'avos.sess'
+    *                 Cookie name for storing the LeanCloud user session.
+    */
+   avosExpressCookieSession = function(options) { };
+
+   /**
+    * @namespace
+    * Express middleware for redirecting the user to the HTTPS endpoint with the same URL.
+    * This API is LeanCloud-specific, and not included in the original Express API.
+    * See <a href="https://leancloud.cn/docs/cloud_code_guide.html#启用https">Cloud Code Guide</a> for details.
+    */
+   avosExpressHttpsRedirect = function() {};
+
+})(this)