2b-logger 中文文档教程

Question

2b-logger

一个简单易用的 JS 记录器。

Installation

    npm install 2b-logger

如果要将安装保存在 package.json 中：

    npm install --save 2b-logger

或者

    npm install --save-dev 2b-logger

Basic usage

此记录器的基本用法如下：

    const loggerConstructor = require ( "2b-logger" );
    const logger = loggerConstructor ();
    logger.info("A nice info message");

或者，在简化版本中：

    const logger = require ( "2b-logger" ) ();
    logger.info("A nice info message");

import require ( "2b-logger" ) 将返回一个构造函数，该函数可以选择接受一个配置对象。

默认选项是：

    {
        "level": "info",
        "noColor": false,
        "timestampFormat": "YYYY-MM-DD @ HH:mm:ss:ms"
    }

Options

options 对象可以接收以下配置：

level (string, default: info)

级别指示哪些消息将被记录，哪些将被丢弃。 可接受的值为 trace、debug、info、warn 和 error。

下表显示了哪些消息将被记录，具体取决于配置的级别：

	Configured Level
		trace	debug	info	warn	error
Message Level:	trace	✔️	❌	❌	❌	❌
	debug	✔️	️️️️️✔️️️️️	❌	❌	❌
	info or success	✔️	✔️	✔️	❌	❌
	warn	✔️	✔️	✔️	✔️	❌
	error	✔️	✔️	✔️	✔️	✔️️

具有 success 级别的消息被认为是 info 级别的消息，但它们具有不同的呈现样式.

noColor (boolean, default: false)

此布尔选项指示记录器不应向呈现的消息添加颜色。

即使记录的消息是彩色的，如果 noColor 设置为 true，它们也会被移除颜色。

示例：

    const logger = require ( "2b-logger" ) ({ noColor: true });
    const chalk = require ( "chalk" );
    logger.info ( chalk.cyan ( "A cyan message" ) );

在这种情况下，重新显示的消息不会 有颜色。

timestampFormat (string, default: YYYY-MM-DD @ HH:mm:ss:ms)

这是呈现消息时要使用的时间戳格式。 可以在此处查看接受的格式。

API

创建记录器后，可以使用以下方法：

logger.trace ( msg1, msg2, ... )

使用 trace 级别记录消息。

logger.debug ( msg1, msg2, ... )

使用 debug 级别记录消息。

logger.info ( msg1, msg2, ... )

使用 info 级别记录消息。

logger.success ( msg1, msg2, ... )

使用 success 级别记录消息。

logger.warn ( msg1, msg2, ... )

使用 warn 级别记录消息。

logger.error ( msg1, msg2, ... )

使用 error 级别记录消息。

ℹ️ - About log parameters

• The logger will ignore null parameters.
• All other parameters will be converted to string, using .toString ( ).
• If, and only if, the result string is neither null nor empty it will be appended to the message, using a space character as separator.

Example output

以下代码：

const logger = require ( "../src/index.js" ) ({
    level: "trace"
});

logger.trace ( "trace", "msg" );
logger.debug ( "debug", "msg" );
logger.info ( "info", "msg" );
logger.success ( "success", "msg" );
logger.warn ( "warn", "msg" );
logger.error ( "error", "msg" );

将产生以下输出：