提交 598f518e 编写于 作者: S shanghuanni

js-apis-hichecker中js示例改为ArkTS

Signed-off-by: Nshanghuanni <shanghuanni1@huawei.com>
上级 864fbb71
......@@ -6,14 +6,12 @@ HiChecker可以作为应用开发阶段使用的检测工具,用于检测代
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```js
```ts
import hichecker from '@ohos.hichecker';
```
## 常量
提供了所有规则类型的常量。
......@@ -21,7 +19,7 @@ import hichecker from '@ohos.hichecker';
**系统能力:** SystemCapability.HiviewDFX.HiChecker
| 名称 | 参数类型 | 说明 |
| ---------------------------------- | -------- | ------------------------------------------------------ |
| ---------------------------------- | ------ | --------------------- |
| RULE_CAUTION_PRINT_LOG | bigint | 告警规则,当有告警时记录日志。 |
| RULE_CAUTION_TRIGGER_CRASH | bigint | 告警规则,当有告警时让应用推出。 |
| RULE_THREAD_CHECK_SLOW_PROCESS | bigint | 检测规则,检测是否有耗时函数被调用。 |
......@@ -38,12 +36,15 @@ addCheckRule(rule: bigint): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------- |
| ---- | ------ | --- | -------- |
| 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}`);
}
```
......@@ -66,12 +67,15 @@ removeCheckRule(rule: bigint): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------- |
| ---- | ------ | --- | -------- |
| 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}`);
}
```
......@@ -94,18 +98,21 @@ containsCheckRule(rule: bigint): boolean
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------- |
| ---- | ------ | --- | -------- |
| rule | bigint | 是 | 需要查询的规则。 |
**返回值:**
| 类型 | 说明 |
| ------- | ---------------------------------------------------------- |
| ------- | ------------------------------------- |
| boolean | 查询结果,true&nbsp;表示规则已添加,false 表示规则未添加。 |
**示例:**
```js
```ts
import hichecker from '@ohos.hichecker';
import { BusinessError } from '@ohos.base'
try {
// 添加一条规则
hichecker.addCheckRule(hichecker.RULE_THREAD_CHECK_SLOW_PROCESS);
......@@ -133,12 +140,12 @@ addRule(rule: bigint): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------- |
| ---- | ------ | --- | -------- |
| rule | bigint | 是 | 需要添加的规则。 |
**示例:**
```js
```ts
// 添加一条规则
hichecker.addRule(hichecker.RULE_CAUTION_PRINT_LOG);
......@@ -162,12 +169,12 @@ removeRule(rule: bigint): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------- |
| ---- | ------ | --- | -------- |
| rule | bigint | 是 | 需要删除的规则。 |
**示例:**
```js
```ts
// 删除一条规则
hichecker.removeRule(hichecker.RULE_CAUTION_PRINT_LOG);
......@@ -187,12 +194,12 @@ getRule(): bigint
**返回值:**
| 类型 | 说明 |
| ------ | ---------------------- |
| ------ | ----------- |
| bigint | 当前系统中添加的规则。 |
**示例:**
```js
```ts
// 添加一条规则
hichecker.addRule(hichecker.RULE_THREAD_CHECK_SLOW_PROCESS);
......@@ -215,18 +222,18 @@ contains(rule: bigint): boolean
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------- |
| ---- | ------ | --- | -------- |
| rule | bigint | 是 | 需要查询的规则。 |
**返回值:**
| 类型 | 说明 |
| ------- | ---------------------------------------------------------- |
| ------- | ------------------------------------- |
| boolean | 查询结果,true&nbsp;表示规则已添加,false 表示规则未添加。 |
**示例:**
```js
```ts
// 添加一条规则
hichecker.addRule(hichecker.RULE_THREAD_CHECK_SLOW_PROCESS);
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册