diff --git a/zh-cn/application-dev/reference/apis/js-apis-hichecker.md b/zh-cn/application-dev/reference/apis/js-apis-hichecker.md index 74cd7a0da311b6683b10fdb273047b376374cc71..6086c7dd20ffcc8badedf680f7161135f4b0ea66 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-hichecker.md +++ b/zh-cn/application-dev/reference/apis/js-apis-hichecker.md @@ -3,29 +3,27 @@ HiChecker可以作为应用开发阶段使用的检测工具，用于检测代码运行过程中部分易忽略的问题，如应用线程出现耗时调用、应用进程中Ability资源泄露等问题。开发者可以通过日志记录或进程crash等形式查看具体问题并进行修改，提升应用的使用体验。 > **说明：** -> +> > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - ## 导入模块 -```js +```ts import hichecker from '@ohos.hichecker'; ``` - ## 常量 提供了所有规则类型的常量。 **系统能力：** SystemCapability.HiviewDFX.HiChecker -| 名称 | 参数类型 | 说明 | -| ---------------------------------- | -------- | ------------------------------------------------------ | -| RULE_CAUTION_PRINT_LOG | bigint | 告警规则，当有告警时记录日志。 | -| RULE_CAUTION_TRIGGER_CRASH | bigint | 告警规则，当有告警时让应用推出。 | -| RULE_THREAD_CHECK_SLOW_PROCESS | bigint | 检测规则，检测是否有耗时函数被调用。 | -| RULE_CHECK_ABILITY_CONNECTION_LEAK | bigint | 检测规则，检测是否发生ability泄露。 | +| 名称 | 参数类型 | 说明 | +| ---------------------------------- | ------ | --------------------- | +| RULE_CAUTION_PRINT_LOG | bigint | 告警规则，当有告警时记录日志。 | +| RULE_CAUTION_TRIGGER_CRASH | bigint | 告警规则，当有告警时让应用推出。 | +| RULE_THREAD_CHECK_SLOW_PROCESS | bigint | 检测规则，检测是否有耗时函数被调用。 | +| RULE_CHECK_ABILITY_CONNECTION_LEAK | bigint | 检测规则，检测是否发生ability泄露。 | ## hichecker.addCheckRule9+ @@ -37,13 +35,16 @@ addCheckRule(rule: bigint): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ---------------- | -| rule | bigint | 是 | 需要添加的规则。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | --- | -------- | +| rule | bigint | 是 | 需要添加的规则。 | **示例：** -```js +```ts +import hichecker from '@ohos.hichecker'; +import { BusinessError } from '@ohos.base'; + try { // 添加一条规则 hichecker.addCheckRule(hichecker.RULE_CAUTION_PRINT_LOG); @@ -51,7 +52,7 @@ try { // hichecker.addCheckRule( // hichecker.RULE_CAUTION_PRINT_LOG | hichecker.RULE_CAUTION_TRIGGER_CRASH); } catch (err) { - console.error(`code: ${err.code}, message: ${err.message}`); + console.error(`code: ${(err as BusinessError).code}, message: ${(err as BusinessError).message}`); } ``` @@ -65,13 +66,16 @@ removeCheckRule(rule: bigint): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ---------------- | -| rule | bigint | 是 | 需要删除的规则。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | --- | -------- | +| rule | bigint | 是 | 需要删除的规则。 | **示例：** -```js +```ts +import hichecker from '@ohos.hichecker'; +import { BusinessError } from '@ohos.base' + try { // 删除一条规则 hichecker.removeCheckRule(hichecker.RULE_CAUTION_PRINT_LOG); @@ -79,7 +83,7 @@ try { // hichecker.removeCheckRule( // hichecker.RULE_CAUTION_PRINT_LOG | hichecker.RULE_CAUTION_TRIGGER_CRASH); } catch (err) { - console.error(`code: ${err.code}, message: ${err.message}`); + console.error(`code: ${(err as BusinessError).code}, message: ${(err as BusinessError).message}`); } ``` @@ -93,19 +97,22 @@ containsCheckRule(rule: bigint): boolean **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ---------------- | -| rule | bigint | 是 | 需要查询的规则。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | --- | -------- | +| rule | bigint | 是 | 需要查询的规则。 | **返回值：** -| 类型 | 说明 | -| ------- | ---------------------------------------------------------- | +| 类型 | 说明 | +| ------- | ------------------------------------- | | boolean | 查询结果，true 表示规则已添加，false 表示规则未添加。 | **示例：** -```js +```ts +import hichecker from '@ohos.hichecker'; +import { BusinessError } from '@ohos.base' + try { // 添加一条规则 hichecker.addCheckRule(hichecker.RULE_THREAD_CHECK_SLOW_PROCESS); @@ -123,7 +130,7 @@ try { addRule(rule: bigint): void > **说明：** -> +> > 从 API Version 9 开始废弃，建议使用[hichecker.addCheckRule](#hicheckeraddcheckrule9)替代。 添加一条或多条规则到系统，系统根据添加的规则进行检测或反馈。 @@ -132,13 +139,13 @@ addRule(rule: bigint): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ---------------- | -| rule | bigint | 是 | 需要添加的规则。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | --- | -------- | +| rule | bigint | 是 | 需要添加的规则。 | **示例：** -```js +```ts // 添加一条规则 hichecker.addRule(hichecker.RULE_CAUTION_PRINT_LOG); @@ -152,7 +159,7 @@ hichecker.addRule( removeRule(rule: bigint): void > **说明：** -> +> > 从 API Version 9 开始废弃，建议使用[hichecker.removeCheckRule](#hicheckerremovecheckrule9)替代。 删除一条或多条规则，删除的规则后续将不再生效。 @@ -161,13 +168,13 @@ removeRule(rule: bigint): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ---------------- | -| rule | bigint | 是 | 需要删除的规则。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | --- | -------- | +| rule | bigint | 是 | 需要删除的规则。 | **示例：** -```js +```ts // 删除一条规则 hichecker.removeRule(hichecker.RULE_CAUTION_PRINT_LOG); @@ -186,13 +193,13 @@ getRule(): bigint **返回值：** -| 类型 | 说明 | -| ------ | ---------------------- | +| 类型 | 说明 | +| ------ | ----------- | | bigint | 当前系统中添加的规则。 | **示例：** -```js +```ts // 添加一条规则 hichecker.addRule(hichecker.RULE_THREAD_CHECK_SLOW_PROCESS); @@ -205,7 +212,7 @@ hichecker.getRule(); // return 1n; contains(rule: bigint): boolean > **说明：** -> +> > 从 API Version 9 开始废弃，建议使用[hichecker.containsCheckRule](#hicheckercontainscheckrule9)替代。 当前已添加的规则集中是否包含了某一个特定的规则，如果传入的规则级别为线程级别，则仅在当前线程中进行查询。 @@ -214,23 +221,23 @@ contains(rule: bigint): boolean **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ---------------- | -| rule | bigint | 是 | 需要查询的规则。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | --- | -------- | +| rule | bigint | 是 | 需要查询的规则。 | **返回值：** -| 类型 | 说明 | -| ------- | ---------------------------------------------------------- | +| 类型 | 说明 | +| ------- | ------------------------------------- | | boolean | 查询结果，true 表示规则已添加，false 表示规则未添加。 | **示例：** -```js +```ts // 添加一条规则 hichecker.addRule(hichecker.RULE_THREAD_CHECK_SLOW_PROCESS); // 查询是否包含 hichecker.contains(hichecker.RULE_THREAD_CHECK_SLOW_PROCESS); // return true; hichecker.contains(hichecker.RULE_CAUTION_PRINT_LOG); // return false; -``` \ No newline at end of file +```