From acfe0ff1d844ffc793cecd7a8886128425eba9d8 Mon Sep 17 00:00:00 2001 From: shawn_he Date: Mon, 21 Feb 2022 19:45:08 +0800 Subject: [PATCH] update docs Signed-off-by: shawn_he --- .../reference/apis/js-apis-hilog.md | 182 ++++++++++++++++++ 1 file changed, 182 insertions(+) create mode 100644 en/application-dev/reference/apis/js-apis-hilog.md diff --git a/en/application-dev/reference/apis/js-apis-hilog.md b/en/application-dev/reference/apis/js-apis-hilog.md new file mode 100644 index 0000000000..a2a02fd14c --- /dev/null +++ b/en/application-dev/reference/apis/js-apis-hilog.md @@ -0,0 +1,182 @@ +# HiLog + +> **Note:** +> +> The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version. + +## Modules to Import + +``` +import hilog from '@ohos.hilog'; +``` + +## System Capabilities + +SystemCapability.HiviewDFX.HiLog + +## hilog.debug + +debug(domain: number, tag: string, format: string, ...args: any[]) : void + +Prints logs of the DEBUG level. + +**Parameters** + +| Name| Type| Mandatory| Description| +| ------ | -------------- | ---- | ------------------------------------------------------------ | +| domain | number | Yes| Service domain. The value ranges from **0x0** to **0xFFFFF**.| +| tag | string | Yes| String constant used to identify the class or service behavior.| +| format | string | Yes| String constant format, including the parameter type and privacy identifier. A parameter without the privacy identifier is treated as a privacy parameter by default.| +| args | any[] | Yes| Variable-length parameter list corresponding to the parameter type in the format string. The number and type of parameters must map to the identifier in the format string.| + +**Example** + +``` +hilog.debug(0xFF00, "testTag", "%d: %{private}s World %{public}f", 1, "hello", 3.0); +``` + +**Output** + +``` +09-08 12:49:35.941 1547 2452 D FF00/testTag: 1: hello World 3.0 +``` + +## **hilog.info** + +info(domain: number, tag: string, format: string, ...args: any[]) : void + +Prints logs of the INFO level. + +**Parameters** + +| Name| Type| Mandatory| Description| +| ------ | -------------- | ---- | ------------------------------------------------------------ | +| domain | number | Yes| Service domain. The value ranges from **0x0** to **0xFFFFF**.| +| tag | string | Yes| String constant used to identify the class or service behavior.| +| format | string | Yes| String constant format, including the parameter type and privacy identifier. A parameter without the privacy identifier is treated as a privacy parameter by default.| +| args | any[] | Yes| Variable-length parameter list corresponding to the parameter type in the format string. The number and type of parameters must map to the identifier in the format string.| + +**Example** + +``` +hilog.info(0xFF00, "testTag", "%d: %{private}s World %{public}f", 1, "hello", 3.0); +``` + +**Output** + +``` +09-08 12:49:35.941 1547 2452 I FF00/testTag: 1: hello World 3.0 +``` + +## hilog.warn + +warn(domain: number, tag: string, format: string, ...args: any[]) : void + +Prints logs of the WARN level. + +**Parameters** + +| Name| Type| Mandatory| Description| +| ------ | -------------- | ---- | ------------------------------------------------------------ | +| domain | number | Yes| Service domain. The value ranges from **0x0** to **0xFFFFF**.| +| tag | string | Yes| String constant used to identify the class or service behavior.| +| format | string | Yes| String constant format, including the parameter type and privacy identifier. A parameter without the privacy identifier is treated as a privacy parameter by default.| +| args | any[] | Yes| Variable-length parameter list corresponding to the parameter type in the format string. The number and type of parameters must map to the identifier in the format string.| + +**Example** + +``` +hilog.warn(0xFF00, "testTag", "%d: %{private}s World %{public}f", 1, "hello", 3.0); +``` + +**Output** + +``` +09-08 12:49:35.941 1547 2452 W FF00/testTag: 1: hello World 3.0 +``` + +## hilog.error + +error(domain: number, tag: string, format: string, ...args: any[]) : void + +Prints logs of the ERROR level. + +**Parameters** + +| Name| Type| Mandatory| Description| +| ------ | -------------- | ---- | ------------------------------------------------------------ | +| domain | number | Yes| Service domain. The value ranges from **0x0** to **0xFFFFF**.| +| tag | string | Yes| String constant used to identify the class or service behavior.| +| format | string | Yes| String constant format, including the parameter type and privacy identifier. A parameter without the privacy identifier is treated as a privacy parameter by default.| +| args | any[] | Yes| Variable-length parameter list corresponding to the parameter type in the format string. The number and type of parameters must map to the identifier in the format string.| + +**Example** + +``` +hilog.error(0xFF00, "testTag", "%d: %{private}s World %{public}f", 1, "hello", 3.0); +``` + +**Output** + +``` +09-08 12:49:35.941 1547 2452 E FF00/testTag: 1: hello World 3.0 +``` + +## hilog.fatal + +fatal(domain: number, tag: string, format: string, ...args: any[]) : void + +Prints logs of the FATAL level. + +**Parameters** + +| Name| Type| Mandatory| Description| +| ------ | -------------- | ---- | ------------------------------------------------------------ | +| domain | number | Yes| Service domain. The value ranges from **0x0** to **0xFFFFF**.| +| tag | string | Yes| String constant used to identify the class or service behavior.| +| format | string | Yes| String constant format, including the parameter type and privacy identifier. A parameter without the privacy identifier is treated as a privacy parameter by default.| +| args | any[] | Yes| Variable-length parameter list corresponding to the parameter type in the format string. The number and type of parameters must map to the identifier in the format string.| + +**Example** + +``` +hilog.fatal(0xFF00, "testTag", "%d: %{private}s World %{public}f", 1, "hello", 3.0); +``` + +**Output** + +``` +09-08 12:49:35.941 1547 2452 F FF00/testTag: 1: hello World 3.0 +``` + +## hilog.isLoggable + +isLoggable(domain: number, tag: string, level: LogLevel) : boolean + +Checks whether printing is enabled for a domain, tag, or log level. + +**Parameters** + +| Name| Type| Mandatory| Description| +| ------ | --------------------- | ---- | ------------------------------------------ | +| domain | number | Yes| Service domain. The value ranges from **0x0** to **0xFFFFF**.| +| tag | string | Yes| String constant used to identify the class or service behavior.| +| level | [LogLevel](#loglevel) | Yes| Log level.| + +**Example** + +``` +hilog.isLoggable(0xFF00, "testTag", hilog.DEBUG); +``` + +## LogLevel + +Enumerates event types. + +| Name| Default Value| Description| +| ----- | ------ | ----------- | +| DEBUG | 3 | DEBUG level| +| INFO | 4 | INFO level| +| WARN | 5 | WARN level| +| ERROR | 6 | ERROR level| +| FATAL | 7 | FATAL level| -- GitLab