Logger - Documentation

Constructor

new Logger(options)

Source:

logger.js, line 99

构造函数

Parameters:

Name	Type	Description
`options`	object	配置选项见Logger.options，若参数为`string`类型，则表示设定为`options.name`的值

Members

(static, readonly) rules :object

Source:

logger.js, line 114

Since:

1.2.0

Properties:

Name	Type	Description
`rules`	object	打印器命名空间规则配置集合

打印器命名空间规则配置项

可以配置整个命名空间是否输出日志
也可以配置命名空间下某个实例方法是否输出日志

Type:

object

(static, readonly) options :object

Source:

logger.js, line 160

Since:

1.0.0

Properties:

Name	Type	Default	Description
`name`	string	`'logger'`	日志器命名空间，默认为'logger'
`debug`	boolean	`true`	调试模式是否开启，默认开启

默认配置选项
为了在生产环境能开启调试模式
提供了从localStorage获取默认配置项的措施

Type:

object

(readonly) $options :object

Source:

logger.js, line 214

Since:

1.0.0

实例初始配置项

Type:

object

(readonly) $name :string

Source:

logger.js, line 226

Since:

1.1.0

获取实例的命名空间配置项

Type:

string

(readonly) $debug :boolean

Source:

logger.js, line 240

Since:

1.1.0

获取实例的调试模式配置项

Type:

boolean

Methods

(static) configRules(rules) → {Logger}

Source:

logger.js, line 135

Since:

1.2.0

更改命名空间规则配置项
[注]从localStorage的LOGGER_RULES键中读取规则配置优先级最高，始终会覆盖其他规则

Example

// 定义规则
Logger.configRules = {
   utils-http:false // 整个utils-http不可打印输出
   utils-calc.log=true // utils-calc打印器的log方法不支持打印输出
}

Parameters:

Name Type Description

rules

object

配置参数

Properties

Name	Type	Attributes	Description
`name`	string	<optional>	日志器命名空间
`debug`	boolean	<optional>	调试模式是否开启

Returns:

Type: Logger

(static) config(options) → {Logger}

Source:

logger.js, line 176

Since:

1.0.0

See:

Logger.options

更新默认配置选项

Parameters:

Name	Type	Description
`options`	object	配置选项见Logger.options

Returns:

Type: Logger

isActivated(methodopt) → {boolean}

Source:

logger.js, line 253

Since:

1.1.0

检测当前是否调试模式是否激活：可以打印日志

Parameters:

Name	Type	Attributes	Description
`method`	string	<optional>	若指定了该参数，则精确检测具体的实例方法

Returns:

Type: boolean

color(color) → {function}

Source:

logger.js, line 294

Since:

1.1.0

创建一个指定颜色的打印方法

Parameters:

Name	Type	Description
`color`	string	颜色值

Returns:

Type: function

enable() → {Logger}

Source:

logger.js, line 305

Since:

1.1.0

启用日志输出

Returns:

Type: Logger

disable() → {Logger}

Source:

logger.js, line 318

Since:

1.1.0

禁用日志输出

Returns:

Type: Logger

log(…args) → {Logger}

Source:

logger.js, line 333

Since:

1.0.0

常规日志打印

Parameters:

Name	Type	Attributes	Description
`args`	*	<repeatable>	任意数据

Returns:

Type: Logger

warn(…args) → {Logger}

Source:

logger.js, line 346

Since:

1.0.0

警告日志打印

Parameters:

Name	Type	Attributes	Description
`args`	*	<repeatable>	任意数据

Returns:

Type: Logger

trace(…args) → {Logger}

Source:

logger.js, line 359

Since:

1.0.1

调用栈日志打印

Parameters:

Name	Type	Attributes	Description
`args`	*	<repeatable>	任意数据

Returns:

Type: Logger

error(…args)

Source:

logger.js, line 372

Since:

1.0.0

错误日志打印，同时会抛出错误，阻塞后续逻辑

Parameters:

Name	Type	Attributes	Description
`args`	*	<repeatable>	参数列表

Throws:

Error - 抛出错误提示

info(…args) → {Logger}

Source:

logger.js, line 391

Since:

1.1.0

See:

Logger#log

log的同名方法，使用方法请参考Logger#log

Parameters:

Name	Type	Attributes	Description
`args`	*	<repeatable>	任意数据

Returns:

Type: Logger

debug(…args) → {Logger}

Source:

logger.js, line 406

Since:

1.1.0

See:

Logger#log

log的同名方法，使用方法请参考Logger#log

Parameters:

Name	Type	Attributes	Description
`args`	*	<repeatable>	任意数据

Returns:

Type: Logger

table(data) → {Logger}

Source:

logger.js, line 421

Since:

1.1.0

区别于console.table

对象或数组类型数据以表格的方式打印
若非这两种数据类型，则调用log方法打印

Parameters:

Name	Type	Description
`data`	*	任意数据

Returns:

Type: Logger

dir(…args) → {Logger}

Source:

logger.js, line 436

Since:

1.1.0

打印纯对象数据

Parameters:

Name	Type	Attributes	Description
`args`	*	<repeatable>	任意数据

Returns:

Type: Logger

dirxml(…args) → {Logger}

Source:

logger.js, line 449

Since:

1.1.0

打印纯对象数据

Parameters:

Name	Type	Attributes	Description
`args`	*	<repeatable>	任意数据

Returns:

Type: Logger

group(label) → {Logger}

Source:

logger.js, line 462

Since:

1.1.0

创建一个组，接下来所有的打印内容，都会包裹在组内，直到调用groupEnd()方法结束，退出组

Parameters:

Name	Type	Description
`label`	string	标签名称

Returns:

Type: Logger

groupCollapsed(label) → {Logger}

Source:

logger.js, line 475

Since:

1.1.0

类似group()方法，区别在于调用该方法后打印的内容都是折叠的，需要手动展开

Parameters:

Name	Type	Description
`label`	string	标签名称

Returns:

Type: Logger

groupEnd() → {Logger}

Source:

logger.js, line 486

Since:

1.1.0

关闭组

Returns:

Type: Logger

count(label) → {Logger}

Source:

logger.js, line 499

Since:

1.1.0

统计被执行的次数

Parameters:

Name	Type	Description
`label`	string	标签名称

Returns:

Type: Logger

time(label) → {Logger}

Source:

logger.js, line 512

Since:

1.1.0

开始设置一个timer追踪操作任意的消耗时间，直到调用timeEnd()结束追踪，消耗时间单位为毫秒

Parameters:

Name	Type	Description
`label`	string	标签名称

Returns:

Type: Logger

timeEnd() → {Logger}

Source:

logger.js, line 523

Since:

1.1.0

结束追踪

Returns:

Type: Logger

timeStamp() → {Logger}

Source:

logger.js, line 534

Since:

1.1.0

结束追踪

Returns:

Type: Logger

profile(label) → {Logger}

Source:

logger.js, line 547

Since:

1.1.0

开始记录一个性能分析简报，直到调用profileEnd()结束记录

Parameters:

Name	Type	Description
`label`	string	标签名称

Returns:

Type: Logger

profileEnd() → {Logger}

Source:

logger.js, line 558

Since:

1.1.0

结束记录

Returns:

Type: Logger

assert(assertion, …args) → {Logger}

Source:

logger.js, line 572

Since:

1.1.0

断言表达式，若结果为false，是抛出失败输出

Parameters:

Name	Type	Attributes	Description
`assertion`	boolean		表达式
`args`	*	<repeatable>	断言失败输出

Returns:

Type: Logger

clear() → {Logger}

Source:

logger.js, line 583

Since:

1.1.0

清空控制台

Returns:

Type: Logger