object.md

## importObject(objectName, options?) @importobject

<!-- UTSUNICLOUDAPIJSON.importObject.description -->

<!-- UTSUNICLOUDAPIJSON.importObject.param -->

<!-- UTSUNICLOUDAPIJSON.importObject.returnValue -->

<!-- UTSUNICLOUDAPIJSON.importObject.compatibility -->

<!-- UTSUNICLOUDAPIJSON.importObject.tutorial -->

### uni-app x内使用云对象的特殊说明@strictly-typed-object

由于强类型语言的限制，uni-app-x在编译时需要读取本地云对象导出的方法列表生成客户端对象。
- 请确保调用的云对象在本地包含导出的方法。
- 请确保本地工程的云对象的方法是正确的。
- 如由于云函数加密等因素导致`index.obj.js`无法被正确解析，请在云对象目录创建`index.obj.d.ts`声明云对象内包含的方法。`index.obj.d.ts`示例代码如下：

```ts
// interface.d.ts
type AnyFunction = (...args: any[]) => any;

declare const add: AnyFunction
declare const update: AnyFunction
declare const deleteRecord: AnyFunction

export { // 上面的写法可以自己调整，仅需保证export内包含所有方法即可
  add,
  update
  deleteRecord as remove
}
```

<!-- UTSUNICLOUDAPIJSON.unicloud-import-object.example -->

### 调用云对象时传入泛型

> 4.13版本起支持，仅安卓端会构造对应的泛型的实例，web端和iOS端泛型仅作为类型使用。

用法：`obj.add<泛型类型>()`

在不传泛型时云对象方法返回的类型为`Promise<UTSJSONObject>`，传入泛型后callFunction返回的类型为`Promise<泛型类型>`

**代码示例**

```ts
// 云对象todo代码
'use strict';
module.exports = {
  async add(title, content) {
    return {
      errCode: 0,
      errMsg: '',
      detail: `Todo added, title: ${title}, content: ${content}`
    }
  },
}
```

```ts
// 客户端代码
const todo = uniCloud.importObject('todo')
type CallObjectResult = {
  errCode : number
  errMsg : string
  detail : string
}
todo.add<CallObjectResult>('todo title', 'todo content').then((res) => {
  const detail = res.detail // res类型为CallObjectResult，可直接通过.detail访问其中detail属性
  console.log(detail)
}).catch((err : any | null) => {
  console.error(err)
})
```