docs: 添加注释

GreyHanky · Jul 26, 2019 · 55facc0 · 55facc0
1 parent ef2914b
commit 55facc0
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 4 deletions.
diff --git a/src/api/test/index.ts b/src/api/test/index.ts
@@ -2,6 +2,7 @@ import * as Hapi from "hapi";
 import TestRequest from "./controller";
 import Validator from "./validator";
 
+
 export default (server: Hapi.Server): Hapi.ServerRoute[] => {
   const testRequest = new TestRequest();
 

diff --git a/src/api/wxLogin/controller.helper.ts b/src/api/wxLogin/controller.helper.ts
@@ -13,7 +13,11 @@ export interface IWxLoginParams {
 
 /**
  * 微信登陆
- * @param {object} {appid,secret,js_code,grant_type}
+ * @param {object} params
+ * @param {string} params.appid
+ * @param {string} params.secret
+ * @param {string} params.js_code
+ * @param {string} params.grant_type
  * @returns {object} {openid, sessionKey}
  */
 export async function getSession(params: IWxLoginParams) {
@@ -28,8 +32,8 @@ export async function getSession(params: IWxLoginParams) {
 
 /**
  * 签发JWT
- * @param userId
- * @returns token
+ * @param {string} userId
+ * @returns {string} token
  */
 export function generateToken(userId: string) {
   const payload = {

diff --git a/src/api/wxLogin/controller.ts b/src/api/wxLogin/controller.ts
@@ -48,7 +48,7 @@ export default class WxLoginController {
     }
 
     // 更新用户信息
-    await usersModel.save(user, {
+    usersModel.save(user, {
       nickName: userInfo.nickName,
       avatarUrl: userInfo.avatarUrl
     });