---
title: API
order: 3
---

<br/>

| 参数名      | 说明                 | 必填 | 类型                                   | 默认值 | 备注 |
|-------------|--------------------|------|----------------------------------------|--------|------|
| query       | 请求函数             | Y    | (variables: object) => Promise<object> | -      |      |
| filters     | 过滤器               | N    | Function[]                             | -      |      |
| variables   | 请求参数             | N    | object                                 | {}     |      |
| interval    | 请求频率             | N    | number                                 | -      |      |
| onCompleted | 请求完成的回调       | N    | Function                               | -      |      |
| onError     | 请求错误时的回调     | N    | Function                               | -      |      |
| component   | 包裹子元素的标签     | N    | any                                    | null   |      |
| className   | 包裹子元素标签的类名 | N    | string                                 | -      |      |
| type        | 数据合并方式         | N    | string                                 | -      |      |
| flag        | 是否请求flag         | N    | boolean                                | true   |      |