jj.js 0.8.8 → 0.10.0

package/lib/logger.js

@@ -1,48 +1,127 @@
-const {app: cfg_app, log: cfg_log} = require('./config');
-
-class Logger
-{
-    constructor(handle) {
-        if(new.target) {
-            class ClildLogger extends this.constructor {}
-            ClildLogger.setHandle(handle);
-            return ClildLogger;
-        }
-    }
-
-    static error(...args) {
-        args.forEach(msg => this.log(msg, 'error'));
-    }
-
-    static warning(...args) {
-        args.forEach(msg => this.log(msg, 'warning'));
-    }
-
-    static info(...args) {
-        args.forEach(msg => this.log(msg, 'info'));
-    }
-
-    static debug(...args) {
-        args.forEach(msg => this.log(msg, 'debug'));
-    }
-
-    static sql(...args) {
-        args.forEach(msg => this.log(msg, 'sql'));
-    }
-
-    static http(...args) {
-        args.forEach(msg => this.log(msg, 'http'));
-    }
-
-    static log(msg, level='info') {
-        (cfg_app.app_debug || ~cfg_log.log_level.indexOf(level)) && this.handle(msg, level);
-    }
-
-    static setHandle(handle) {
-        this.handle = typeof(handle) == 'function' ? handle : cfg_log.log_handle;
-    }
-}
-
-Logger.setHandle(cfg_log.log_handle);
-
+const {app: cfg_app, log: cfg_log} = require('./config');
+
+/**
+ * @typedef {import('../types').LogHandle} LogHandle
+ */
+
+class Logger
+{
+    /**
+     * Creat a new `Logger` class
+     * @public
+     * @static
+     * @param {LogHandle} [handle]
+     */
+    constructor(handle) {
+        if(new.target) {
+            // @ts-ignore
+            class ClildLogger extends this.constructor {}
+            // @ts-ignore
+            ClildLogger.setHandle(handle);
+            return ClildLogger;
+        }
+    }
+
+    /**
+     * 输出system日志
+     * @public
+     * @static
+     * @param  {...any} args
+     */
+    static system(...args) {
+        this.log('system', ...args);
+    }
+
+    /**
+     * 输出error日志
+     * @public
+     * @static
+     * @param  {...any} args
+     */
+    static error(...args) {
+        this.log('error', ...args);
+    }
+
+    /**
+     * 输出warning日志
+     * @public
+     * @static
+     * @param  {...any} args
+     */
+    static warning(...args) {
+        this.log('warning', ...args);
+    }
+
+    /**
+     * 输出info日志
+     * @public
+     * @static
+     * @param  {...any} args
+     */
+    static info(...args) {
+        this.log('info', ...args);
+    }
+
+    /**
+     * 输出debug日志
+     * @public
+     * @static
+     * @param  {...any} args
+     */
+    static debug(...args) {
+        this.log('debug', ...args);
+    }
+
+    /**
+     * 输出sql日志
+     * @public
+     * @static
+     * @param  {...any} args
+     */
+    static sql(...args) {
+        this.log('sql', ...args);
+    }
+
+    /**
+     * 输出http日志
+     * @public
+     * @static
+     * @param  {...any} args
+     */
+    static http(...args) {
+        this.log('http', ...args);
+    }
+
+    /**
+     * 输出error日志
+     * @public
+     * @static
+     * @param  {string} level - 日志级别、标识
+     * @param  {...any} args - 日志内容
+     */
+    static log(level='info', ...args) {
+        (cfg_app.app_debug || ~cfg_log.log_level.indexOf(level)) && this.handle(level, ...args);
+    }
+
+    /**
+     * 设置日志handle
+     * @public
+     * @static
+     * @param {LogHandle} handle
+     * @returns {Logger}
+     */
+    static setHandle(handle) {
+        /**
+         * @type {LogHandle}
+         */
+        this.handle = typeof handle == 'function' ? handle : cfg_log.log_handle;
+        return this;
+    }
+}
+
+/**
+ * 设置日志handle
+ */
+Logger.setHandle(cfg_log.log_handle);
+
 module.exports = Logger;

package/lib/middleware.js

@@ -1,27 +1,59 @@
-const Context = require('./context');
-
-class Middleware extends Context
-{
-    constructor(ctx, next) {
-        super(ctx);
-        this.$next = next;
-    }
-
-    $show(content) {
-        this.$response.show(content);
-    }
-
-    $redirect(url, status) {
-        this.$response.redirect(url, status);
-    }
-
-    $success(msg, url) {
-        this.$response.success(msg, url);
-    }
-
-    $error(msg, url) {
-        this.$response.error(msg, url);
-    }
-}
-
+const Context = require('./context');
+
+/**
+ * @extends Context
+ */
+class Middleware extends Context
+{
+    /**
+     * Initialize a new `Middleware`
+     * @public
+     * @param {import('../types').KoaCtx} ctx
+     * @param {import('../types').AsyncNext} [next]
+     */
+    constructor(ctx, next) {
+        super(ctx);
+        this.$next = next;
+    }
+
+    /**
+     * 直接输出内容
+     * @public
+     * @param {*} data
+     */
+    $show(data) {
+        this.$response.show(data);
+    }
+ 
+    /**
+     * 跳转重定向
+     * @public
+     * @param {(string|object)} url
+     * @param {number} [status]
+     */
+    $redirect(url, status) {
+        this.$response.redirect(url, status);
+    }
+
+    /**
+     * 输出成功提示（html|json）
+     * @public
+     * @param {(string|object)} [msg]
+     * @param {(string|object)} [url]
+     */
+    $success(msg, url) {
+        this.$response.success(msg, url);
+    }
+
+    /**
+     * 输出错误提示（html|json）
+     * @public
+     * @param {(string|object)} [msg]
+     * @param {(string|object)} [url]
+     */
+    $error(msg, url) {
+        this.$response.error(msg, url);
+    }
+}
+
 module.exports = Middleware;

package/lib/model.js

@@ -1,19 +1,47 @@
 const Context = require('./context');
 const {toLine} = require('./utils/str');
 
+/**
+ * @typedef {import('../types').OkPacket} OkPacket
+ * @typedef {import('../types').RowData} RowData
+ * @typedef {import('../types').ListData} ListData
+ */
+
+/**
+ * @extends Context
+ */
 class Model extends Context
 {
+    /**
+     * Initialize a new `Model`
+     * @public
+     * @param {import('../types').KoaCtx} ctx
+     */
     constructor(ctx) {
         super(ctx);
         this.connection = null;
         this.table = toLine(this.constructor.name);
         this.pk = 'id';
+        this._db;
     }
 
+    /**
+     * 插入一条数据
+     * @public
+     * @param {object} data - 待插入数据
+     * @returns {Promise<OkPacket>}
+     */
     async add(data) {
         return await this.db.allowField().insert(data);
     }
 
+    /**
+     * 更新或插入一条数据
+     * @public
+     * @param {object} data - 更新或插入数据
+     * @param {object} [condition] - 更新条件，不为空或data包含主键则更新数据，否则插入数据
+     * @returns {Promise<OkPacket>}
+     */
     async save(data, condition = {}) {
         if(data[this.pk] || Object.keys(condition).length) {
             if(data[this.pk]) {
@@ -27,19 +55,40 @@ class Model extends Context
         return await this.add(data);
     }
 
+    /**
+     * 删除数据
+     * @public
+     * @param {object} condition - 删除条件
+     * @returns {Promise<OkPacket>}
+     */
     async del(condition) {
         return await this.db.delete(condition);
     }
 
+    /**
+     * 查询一条数据
+     * @public
+     * @param {object} condition - 查询条件
+     * @returns {Promise<(RowData|null)>}
+     */
     async get(condition) {
         return await this.db.find(condition);
     }
 
+    /**
+     * 查询多条数据
+     * @public
+     * @param {object} condition - 查询条件
+     * @returns {Promise<(ListData)>}
+     */
     async all(condition) {
         return await this.db.select(condition);
     }
 
-    //数据库实例
+    /**
+     * 数据库实例
+     * @type {import('../types').DbInstance}
+     */
     get db() {
         if(!this._db){
             this._db = new (require('./db'))(this.ctx);