Class (Console)

本模块提供了一个简单的调试控制台,类似于浏览器提供的JavaScript控制台机制。

本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

console.debug

static debug(message: string, ...arguments: any[]): void

以格式化输出方式打印调试信息。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
message string 是 表示要打印的文本信息。
arguments any[] 否 表示其余要打印的信息或message的替换值。

示例:

const number = 5;
console.debug('count: %d', number);  // 格式化输出替换message中的文本。
// count: 5
console.debug('count:', number);  // 打印message以及其余信息
// count: 5
console.debug('count:'); // 仅打印message
// count:

console.log

static log(message: string, ...arguments: any[]): void

以格式化输出方式打印日志信息。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
message string 是 表示要打印的文本信息。
arguments any[] 否 表示其余要打印的信息或message的替换值。

示例:

const number = 5;
console.log('count: %d', number);  // 格式化输出替换message中的文本。
// count: 5
console.log('count:', number);  // 打印message以及其余信息
// count: 5
console.log('count:'); // 仅打印message
// count:

console.info

static info(message: string, ...arguments: any[]): void

以格式化输出方式打印日志信息(console.log()的别名)。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
message string 是 表示要打印的文本信息。
arguments any[] 否 表示其余要打印的信息或message的替换值。

示例:

const number = 5;
console.info('count: %d', number);  // 格式化输出替换message中的文本。
// count: 5
console.info('count:', number);  // 打印message以及其余信息
// count: 5
console.info('count:'); // 仅打印message
// count:

console.warn

static warn(message: string, ...arguments: any[]): void

以格式化输出方式打印警告信息。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
message string 是 表示要打印的警告信息。
arguments any[] 否 表示其余要打印的信息或message的替换值。

示例:

const str = "name should be string";
console.warn('warn: %d', str);  // 格式化输出替换message中的文本。
// warn: name should be string
console.warn('warn:', str);  // 打印message以及其余信息
// warn: name should be string
console.warn('warn:'); // 仅打印message
// warn:

console.error

static error(message: string, ...arguments: any[]): void

以格式化输出方式打印错误信息。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
message string 是 表示要打印的错误信息。
arguments any[] 否 表示其余要打印的信息或message的替换值。

示例:

const str = "value is not defined";
console.error('error: %d', str);  // 格式化输出替换message中的文本。
// error: value is not defined
console.error('error:', str);  // 打印message以及其余信息
// error: value is not defined
console.error('error:'); // 仅打印message
// error:

console.assert10+

static assert(value?: Object, ...arguments: Object[]): void

断言打印。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

参数:

参数名 类型 必填 说明
value Object 否 语句结果值。若value为假(false)或者省略,则输出以"Assertion failed"开头。如果value为真值(true),则无打印。
arguments Object 否 value为假(false)的后续错误消息打印。省略则不打印。

错误码:

以下错误码的详细介绍请参见通用错误码。

错误码ID 错误信息
401 Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

console.assert(true, 'does nothing');  // 表达式结果值为true, 无打印。
console.assert(2 % 1 == 0, 'does nothing');  // 表达式结果值为true, 无打印。

console.assert(false, 'console %s work', 'didn\'t');
// Assertion failed: console didn't work

console.assert();
// Assertion failed

console.count10+

static count(label?: string): void

维护一个内部计数器,调用时,打印此标签名以及对应的计数次数。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

参数:

参数名 类型 必填 说明
label string 否 计数器标签名。默认值为'default'。

错误码:

以下错误码的详细介绍请参见通用错误码。

错误码ID 错误信息
401 Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

console.count()
// default: 1
console.count('default')
// default: 2
console.count('abc')
// abc: 1
console.count('xyz')
// xyz: 1
console.count('abc')
// abc: 2
console.count()
// default: 3

console.countReset10+

static countReset(label?: string): void

清除指定标签名的计数。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

参数:

参数名 类型 必填 说明
label string 否 计数器标签名。默认值为'default'。

错误码:

以下错误码的详细介绍请参见通用错误码。

错误码ID 错误信息
401 Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

console.count('abc');
// abc: 1
console.countReset('abc');
console.count('abc');
// abc: 1

console.dir10+

static dir(dir?: Object): void

打印对象内容。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

参数:

参数名 类型 必填 说明
dir Object 否 需要打印内容的对象。省略则无任何打印。

示例:

class bar {
  baz: boolean = true;
}
let b: bar = {baz: true}
class foo{
  bar: bar = b;
}
let c: foo = {bar: b}
class  c1{
  foo: foo = c;
}
let a: c1 = {foo: c}
console.dir(a);
// Object: {"foo":{"bar":{"baz":true}}}

console.dir(); // 无打印

console.dirxml10+

static dirxml(...arguments: Object[]): void

此方法通过内部调用console.log()实现。此方法不会产生任何 XML 格式。使用方法与console.log()一致。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

参数:

参数名 类型 必填 说明
arguments Object 否 要打印的信息。省略则无任何打印。

示例:

const number = 5;
console.dirxml('count: %d', number);
// count: 5
console.dirxml('count:', number);
// count: 5
console.dirxml('count:');
// count:

console.group10+

static group(...arguments: Object[]): void

默认将后续行的缩进增加两个空格。

如果提供需要打印的信息,则首先打印信息,没有额外的缩进。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

参数:

参数名 类型 必填 说明
arguments Object 否 要打印的信息。省略则仅打印两个空格。

示例:

console.info("outer");
console.group();
console.info("level 1");
console.group("in level1");
console.info("level 2");
/**
 * outer
 *   level 1
 *   in level1
 *     level 2
 */

console.groupCollapsed10+

static groupCollapsed(...arguments: Object[]): void

使用与功能同console.group()一致。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

参数:

参数名 类型 必填 说明
arguments Object 否 要打印的信息。省略则仅打印两个空格。

示例:

console.groupCollapsed("outer");
console.groupCollapsed();
console.info("level 1");
console.groupCollapsed("in level1");
console.info("level 2");
/**
 * outer
 *   level 1
 *   in level1
 *     level 2
 */

console.groupEnd10+

static groupEnd(): void

将后续行的缩进减少两个空格。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

示例:

console.info("outer");
console.group();
console.info("level 1");
console.groupEnd();
console.info("outer");
/**
 * outer
 *   level 1
 * outer
 */

console.table10+

static table(tableData?: Object): void

以表格形式打印数据。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

参数:

参数名 类型 必填 说明
tableData Object 否 要打印为表格形式的对象。省略则无任何打印。

示例:

console.table([1, 2, 3]);
// ┌─────────┬────────┐
// │ (index) │ Values │
// ├─────────┼────────┤
// │    0    │   1    │
// │    1    │   2    │
// │    2    │   3    │
// └─────────┴────────┘

console.table({ a: [1, 2, 3, 4, 5], b: 5, c: { e: 5 } });

// ┌─────────┬───┬───┬───┬───┬───┬───┬────────┐
// │ (index) │ 0 │ 1 │ 2 │ 3 │ 4 │ e │ Values │
// ├─────────┼───┼───┼───┼───┼───┼───┼────────┤
// │    a    │ 1 │ 2 │ 3 │ 4 │ 5 │   │        │
// │    b    │   │   │   │   │   │   │   5    │
// │    c    │   │   │   │   │   │ 5 │        │
// └─────────┴───┴───┴───┴───┴───┴───┴────────┘

console.time10+

static time(label?: string): void

启动可用于计算操作持续时间的计时器。可使用console.timeEnd()关闭计时器并打印经过的时间(单位:ms)。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

参数:

参数名 类型 必填 说明
label string 否 计时器标识。默认值为'default'。

错误码:

以下错误码的详细介绍请参见通用错误码。

错误码ID 错误信息
401 Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

console.time('abc');

console.timeEnd10+

static timeEnd(label?: string): void

停止之前通过调用 console.time() 启动的计时器并将打印经过的时间(单位:ms)。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

参数:

参数名 类型 必填 说明
label string 否 计时器标识。默认值为'default'。

错误码:

以下错误码的详细介绍请参见通用错误码。

错误码ID 错误信息
401 Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

console.time('abc');
console.timeEnd('abc');
// abc: 225.438ms

console.timeLog10+

static timeLog(label?: string, ...arguments: Object[]): void

对于先前通过调用 console.time() 启动的计时器,打印经过时间和其他data参数。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

参数:

参数名 类型 必填 说明
label string 否 计时器标识。默认值为'default'。
arguments Object 否 需要打印的其他日志。

错误码:

以下错误码的详细介绍请参见通用错误码。

错误码ID 错误信息
401 Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

console.time('timer1');
console.timeLog('timer1', 17);
// timer1: 365.227ms 17
console.timeEnd('timer1');
// timer1: 513.22ms

console.trace10+

static trace(...arguments: Object[]): void

打印当前堆栈。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

参数:

参数名 类型 必填 说明
arguments Object 否 需要打印的其他日志。省略则仅打印堆栈信息。

示例:

console.trace();
console.trace("Show the trace");
/**
 * Trace:
 *     xxxxxxxxxx(当前堆栈信息)
 * Trace: Show the trace
 *     xxxxxxxxxx(当前堆栈信息)
 */

console.traceHybridStack12+

static traceHybridStack(): void

在主线程/worker线程中可打印当前线程混合堆栈信息。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

示例:

console.traceHybridStack();
/**
 * TraceHybridStack:
 *     xxxxxxxxxx(当前线程混合堆栈信息)
 */