js-apis-base.md 2.6 KB
Newer Older
E
ester.zhou 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
# @ohos.base (Public Callback Information)

The **Base** module defines the public callback types of ArkTS APIs, including the common and error callbacks.

> **NOTE**
>
> The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.

## Modules to Import

```
import base from '@ohos.base';
```

## Callback

Callback\<T> {

(data: T): void;

}

Defines a common callback.

You can set **data** to customize the data type of the information returned by the callback.

**System capability**: SystemCapability.Base

| Name| Type| Mandatory| Description                      |
| ---- | ---- | ---- | -------------------------- |
| data | T    | Yes  | Common callback information.|

## ErrorCallback

ErrorCallback\<T extends Error = BusinessError> {

(err: T): void;

}

Defines a common callback that carries an error parameter.

The error parameter is of the [BusinessError](#businesserror) type.

**System capability**: SystemCapability.Base

**Parameters**

| Name| Type| Mandatory| Description                        |
| ---- | ---- | ---- | ---------------------------- |
| err  | T    | Yes  | Common error information about the API invoking failure.|

## AsyncCallback

AsyncCallback\<T, E = void> {

(err: BusinessError, data: T): void;

}

Defines a common callback that carries an error parameter and asynchronous return value.

The error parameter is of the [BusinessError](#businesserror) type.

The type of the asynchronous return value is defined by the developer.

**System capability**: SystemCapability.Base

| Name| Type                                                        | Mandatory| Description                        |
| ---- | ------------------------------------------------------------ | ---- | ---------------------------- |
| err  | [BusinessError](https://gitee.com/openharmony/docs/pulls/20172/files#businesserror) | Yes  | Common error information about the API invoking failure.|
| data | T                                                            | Yes  | Common callback information.  |

## BusinessError

BusinessError\<T = void> extends Error {

code: number;

data?: T;
}

Defines the error parameter.

**System capability**: SystemCapability.Base

| Name| Type  | Mandatory| Description                                                      |
| ---- | ------ | ---- | ---------------------------------------------------------- |
| code | number | Yes  | Common error information about the API invoking failure.                            |
| data | T      | No  | Common callback information. If this parameter is left empty, no related information is returned.|