@addesign/wwt-logger 中文文档教程

Question

WWT Logger

创建记录器模块是为了记录特定信息。 模板如下所示：

示例：    ERROR [2020 年 11 月 19 日星期四 19:14:58 GMT]：数据库连接出现问题

An example of using the logger:

const path = require("path");
const Logger = require("@addesign/wwt-logger)

const logger_instance = new Logger({ dir: path.join(__dirname, "logs") });
const {logType} = logger_instance

为了向日志文件添加条目，请使用以下代码：

logger_instance.set(logeType.ERROR, `something text for log file`, (err) => { callback })

要获取文件，只需使用 get 方法，我们可以使用内置类型：

const {logType} = logger_instance
logger_instance.get(logType.ERROR, (err, data) => { callback })

An example of using a logger to write all logs to one file:

const path = require("path");
const Logger = require("@addesign/wwt-logger")
const loggerConfig = { 
    dir: path.join(__dirname, "your directory"),
    singleFile: true, 
    singleFileName: "logsFileExample"
}

const instanceLogger = new Logger(loggerConfig)

如果指定了 singleFile，则必须指定 singleFileName。 LoggerConfig 中的 singleFileName 属性不得在文件名末尾包含 ".log"。

An example of using the logger with Express.js:

const path = require("path");
const ExpressLogger = require("@addesign/wwt-logger/express")
...
const loggerConfig = { dir: path.join(__dirname, "your directory") }

app
  .use(ExpressLogger(loggerConfig))
  .use((req) => {
    req.logger.logType // log types
    req.logger.get(...)
    req.logger.set(...)
  });

所有记录器类型：

enum LogTypes {
  ERROR = "ERROR",
  INFO = "INFO",
  WARNING = "WARNING",
  DEBUG = "DEBUG",
  FATAL = "FATAL"
}

Licence

版权所有 (c) 2020 AD design ©

特此免费向任何获得副本的人授予许可 本软件和相关文档文件（“软件”），处理 在软件中不受限制，包括但不限于权利 使用、复制、修改、合并、发布、分发、再许可和/或出售 该软件的副本，并允许该软件是 提供这样做，但须满足以下条件：

上述版权声明和本许可声明应包含在所有 软件的副本或重要部分。

软件“按原样”提供，不提供任何形式的明示或保证 暗示的，包括但不限于适销性保证， 适用于特定目的和非侵权。 在任何情况下都不得 作者或版权持有人对任何索赔、损害或其他 责任，无论是在合同、侵权或其他方面的行为中，由以下原因引起， 出于或与软件或使用或其他交易有关 软件。