模块 console

控制台访问对象

全局对象。可用于提示信息,警告和错误记录。通过启动配置文件,可将日志定位到不同的设备,以便于跟踪。日志支持格式化输出,例如:

console.log("%d + %d = %d", 100, 200, 100 + 200);

可以使用的格式化参数如下:

静态函数

add

添加 console 输出系统,支持的设备为 console, syslog, event,最多可以添加 10 个输出

static console.add(String type);

调用参数:

通过配置 console,可以将程序输出和系统错误发往不同设备,用于运行环境信息收集。

type 为配置,为设备名称字符串:

console.add("console");

syslog 仅在 posix 平台有效:

console.add("syslog");

event 仅在 windows 平台有效:

console.add("event");

添加 console 输出系统,支持的设备为 console, syslog, event 和 file,最多可以添加 10 个输出

static console.add(Object cfg);

调用参数:

通过配置 console,可以将程序输出和系统错误发往不同设备,用于运行环境信息收集。

cfg 可以为一个设备配置对象:

console.add({
    type: "console",
    levels: [console.INFO, console.ERROR] // 选项,省略则输出全部级别日志
});

syslog 仅在 posix 平台有效:

console.add({
    type: "syslog",
    levels: [console.INFO, console.ERROR]
});

event 仅在 windows 平台有效:

console.add({
    type: "event",
    levels: [console.INFO, console.ERROR]
});

file 日志:

console.add({
    type: "file",
    levels: [console.INFO, console.ERROR],
    // 必选项,指定日志输出文件,可使用 s% 指定插入日期位置,不指定则添加在结尾
    path: "path/to/file_%s.log",
    // 选项,可选值为 "day", "hour", "minute", "###k", "###m", "###g",缺省为 "1m"
    split: "30m",
    // 选项,可选范围为 2-128,缺省为 128
    count: 10
});

批量添加 console 输出系统,支持的设备为 console, syslog, event 和 file,最多可以添加 10 个输出

static console.add(Array cfg);

调用参数:

通过配置 console,可以将程序输出和系统错误发往不同设备,用于运行环境信息收集。

console.add(["console", {
    type: "syslog",
    levels: [console.INFO, console.ERROR]
}]);

reset

初始化到缺省设置,只在 console 输出信息

static console.reset();

log

记录普通日志信息,与 info 等同

static console.log(String fmt,
    ...);

调用参数:

记录一般等级的日志信息。通常用于输出非错误性提示信息。


记录普通日志信息,与 info 等同

static console.log(...);

调用参数:

记录一般等级的日志信息。通常用于输出非错误性提示信息。


debug

记录调试日志信息

static console.debug(String fmt,
    ...);

调用参数:

记录调试日志信息。通常用于输出调试信息。不重要。


记录调试日志信息

static console.debug(...);

调用参数:

记录调试日志信息。通常用于输出调试信息。不重要。


info

记录普通日志信息,与 log 等同

static console.info(String fmt,
    ...);

调用参数:

记录一般等级的日志信息。通常用于输出非错误性提示信息。


记录普通日志信息,与 log 等同

static console.info(...);

调用参数:

记录一般等级的日志信息。通常用于输出非错误性提示信息。


notice

记录警告日志信息

static console.notice(String fmt,
    ...);

调用参数:

记录警告日志信息。通常用于输出提示性调试信息。一般重要。


记录警告日志信息

static console.notice(...);

调用参数:

记录警告日志信息。通常用于输出提示性调试信息。一般重要。


warn

记录警告日志信息

static console.warn(String fmt,
    ...);

调用参数:

记录警告日志信息。通常用于输出警告性调试信息。重要。


记录警告日志信息

static console.warn(...);

调用参数:

记录警告日志信息。通常用于输出警告性调试信息。重要。


error

记录错误日志信息

static console.error(String fmt,
    ...);

调用参数:

记录用于错误日志信息。通常用于输出错误信息。非常重要。系统的出错信息也会以此等级记录。


记录错误日志信息

static console.error(...);

调用参数:

记录用于错误日志信息。通常用于输出错误信息。非常重要。系统的出错信息也会以此等级记录。


crit

记录关键错误日志信息

static console.crit(String fmt,
    ...);

调用参数:

记录用于关键错误日志信息。通常用于输出关键错误信息。非常重要。


记录关键错误日志信息

static console.crit(...);

调用参数:

记录用于关键错误日志信息。通常用于输出关键错误信息。非常重要。


alert

记录警报错误日志信息

static console.alert(String fmt,
    ...);

调用参数:

记录用于警报错误日志信息。通常用于输出警报错误信息。非常重要。为最高级别信息。


记录警报错误日志信息

static console.alert(...);

调用参数:

记录用于警报错误日志信息。通常用于输出警报错误信息。非常重要。为最高级别信息。


dir

用 JSON 格式输出对象

static console.dir(Value obj);

调用参数:


time

启动一个计时器

static console.time(String label = "time");

调用参数:


timeEnd

统计指定计时器的数值

static console.timeEnd(String label = "time");

调用参数:


trace

输出当前调用堆栈

static console.trace(String label = "trace");

调用参数:

通过日志输出当前调用堆栈。


assert

断言测试,如果测试值为假,则报错

static console.assert(Value value,
    String msg = "");

调用参数:


print

向控制台输出格式化文本,输出内容不会记入日志系统,输出文本后不会自动换行,可连续输出

static console.print(String fmt,
    ...);

调用参数:


向控制台输出格式化文本,输出内容不会记入日志系统,输出文本后不会自动换行,可连续输出

static console.print(...);

调用参数:


moveTo

移动控制台光标到指定位置

static console.moveTo(Integer row,
    Integer column);

调用参数:


hideCursor

隐藏控制台光标

static console.hideCursor();

showCursor

显示控制台光标

static console.showCursor();

clear

清除控制台

static console.clear();

keyDown

按下一个按键

static console.keyDown(String key,
    String modifier = "");

调用参数:

参数 key 可以使用字符串传入功能键:


按下一个按键

static console.keyDown(String key,
    Array modifier);

调用参数:

参数 key 可以使用字符串传入功能键:


keyUp

松开一个按键

static console.keyUp(String key,
    String modifier = "");

调用参数:

参数 key 可以使用字符串传入功能键:


松开一个按键

static console.keyUp(String key,
    Array modifier);

调用参数:

参数 key 可以使用字符串传入功能键:


keyTap

点击并松开一个按键

static console.keyTap(String key,
    String modifier = "");

调用参数:

参数 key 可以使用字符串传入功能键:


点击并松开一个按键

static console.keyTap(String key,
    Array modifier);

调用参数:

参数 key 可以使用字符串传入功能键:


typeString

输入一个字符串

static console.typeString(String text);

调用参数:


moveMouse

移动鼠标到指定的位置

static console.moveMouse(Integer x,
    Integer y);

调用参数:


mouseUp

按下一个鼠标键

static console.mouseUp(String button);

调用参数:


mouseDown

放开一个鼠标键

static console.mouseDown(String button);

调用参数:


clickMouse

点击一个鼠标键

static console.clickMouse(String button,
    Boolean dbclick = false);

调用参数:


readLine

从控制台读取用户输入

static String console.readLine(String msg = "") async;

调用参数:

返回结果:

静态属性

loglevel

Integer, 输出级别,用以过滤输出信息,缺省为 NOTSET,全部输出。信息过滤之后才会输出给 add 设定的各个设备。

static Integer console.loglevel;

colors

TextColor, 终端输出颜色配置对象,详见 TextColor

static readonly TextColor console.colors;

width

Integer, 查询终端每行字符数

static readonly Integer console.width;

height

Integer, 查询终端行数

static readonly Integer console.height;

常量

FATAL

loglevel 级别常量

const console.FATAL = 0;

ALERT

loglevel 级别常量

const console.ALERT = 1;

CRIT

loglevel 级别常量

const console.CRIT = 2;

ERROR

loglevel 级别常量

const console.ERROR = 3;

WARN

loglevel 级别常量

const console.WARN = 4;

NOTICE

loglevel 级别常量

const console.NOTICE = 5;

INFO

loglevel 级别常量

const console.INFO = 6;

DEBUG

loglevel 级别常量

const console.DEBUG = 7;

PRINT

loglevel 仅用于输出,信息输出后不换行,file 和 syslog 不保存此级别信息

const console.PRINT = 9;

NOTSET

loglevel 级别常量

const console.NOTSET = 10;