在现代的 web 开发中，日志记录是非常重要的。日志可以帮助我们快速诊断应用中的问题，从而快速解决问题。而 ATM-Logging 是一个非常优秀的 JavaScript 日志模块库，它提供了非常灵活的日志记录方式和多种输出格式。
在本篇文章中，我们将为您介绍如何使用这个 npm 包。
安装
使用 npm install 命令可以快速安装 ATM-Logging 模块库。
--- ------- -----------
用法
----- - ------------- - - ----------------------- ----- ------ - --- ---------------- ------------------ -- - ----- ----------- ------------------ -- -- ----- ----------- ----------------- -- -- ---- ----------- ----------------- -- - ------- -----------
上面的代码片段演示了 atm-logging 的基本用法，创建一个 ConsoleLogger 实例，然后使用 debug、error、info、warn 方法输出日志信息。
在 ATM-Logging 中还有其他非常有用的组件和方法，接下来我们将介绍更多内容。
FileLogger 组件
使您可以将日志写入文件。可以使用以下命令调用：
----- - ---------- - - ----------------------- ----- ------- - - --------- -------------- -------- -- -- -- --------- -- ------ ------- -- ----- ------ - --- -------------------- ------------------ -- - ----- ----------- ------------------ -- -- ----- ----------- ----------------- -- -- ---- ----------- ----------------- -- - ------- -----------
上面的代码中我们创建了一个名为 FileLogger 的新组件，并通过 options 设置了日志文件的名称为 logfile.log，文件最大大小为 2 MB，保留的最大文件数量为 5 个，日志记录级别为 "info"。
如果您的 log 文件达到指定的 maxSize，则将进行 rotation，并将日志写入新的文件。
初始化
您可以通过如下方式 设置 log 记录级别，以及在启用 debug 和日志记录输出之前进行日志记录初始化：
----- - ------------- - - ----------------------- ----- ------ - --- ---------------- -- ------ ------------------------- -- ------- --------------- -- ------------- ------- ------- ------------------- ----------- ----------------- ----------- -- ------------- ------ ----- ------------------------ ------------------- ----------- ----------------- ----------- -- ------- ------------------------ ------------------- ----------- -- --- -- ------- ----------------------- ------------------- ----------- -- ---
在以上示例代码中，我们设置了日志级别为“debug”，重置了记录，然后开始记录日志。随后，我们更新日志级别并演示了如何禁用和启用某些记录级别。
API 详解
在本节中，我们将介绍 ATM-Logging 的 API 详解。在他们的 github 文档 以及 npm 官方 仓库 中可以了解更多信息。
ConsoleLogger
ConsoleLogger(options?): 构造函数。构造器：创建 ConsoleLogger 的实例。可选参数 options 是对象，包含以下属性：
level: 默认是Logger.LEVEL.INFO。color: 选择是否使用 ANSI escape codes 来颜色化输出日志。如果值是 false 或者 undefined，关掉日志颜色。默认是使用颜色输出。timestamp: boolean 是否输出时间戳，默认是 true。name: string 创建name相关的日志在name属性里，默认为空字符串。allUrls: boolean 输出所有出现该url的请求日志，默认是 false。urlFilter: string 过滤只输出符合某个url的请求日志，值是 string 类型。注意，它的定义可能会被包含正则表达式。allMethods: boolean 输出所有 http 请求方法类型的请求日志，默认是 false。methodFilter: string 过滤只输出符合某个请求方法的请求日志，值是 string 类型。注意，它的定义可能会被包含正则表达式。
FileLogger
FileLogger. 构造函数。构造函数：为 FileLogger 创建实例。可选参数 options 是一个对象，包含以下属性：
filename: 日志输出的文件名，默认是logfile.log。maxSize: 日志文件的大小阈值，单位为 MB。默认是 10。maxFiles: 保留的最大日志文件数量。默认为 10。level: 日志记录级别。默认是Logger.LEVEL.INFO。
FileLogger.prototype.write(log:string(该日志段必须以 \n 结尾)`): 写一条日志到文件。
详见 ATM-Logging 文档。
结论
ATM-Logging 是一个非常棒的 npm 包，它提供了很多日志记录方案，帮助我们更加高效地调试应用程序。我们可以使用 ConsoleLogger 来在控制台打印日志信息，并可以使用 FileLogger 将日志记录到文件中。
这非常有用，因为我们可以在错误发生时，追踪会话日志，并了解应用程序中的所有细节。因此，如果您正在进行 web 开发，ATM-Logging 是一个必备的库，应该值得一试！
示例代码你们可以在 npm 以及 github 中查找!
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/6005681681e8991b448e43a6