createFunction API

提供在页面上加载数据的后端函数。

导入

import { createFunction } from '@toolpad/studio/server';

描述

export const myApi = createFunction(config, resolver);

使用 createFunction 使任何后端数据在您的页面上可用。在 toolpad/resources/functions.ts 中定义一个使用 createFunction 初始化的命名导出。完成此操作后，在页面上创建自定义函数查询时，该函数将可用。在后端调用此函数的结果将作为页面状态提供。

您可以定义要绑定到页面状态的参数。当调用该函数加载数据时，将提供这些参数的实际值。

参数

resolver 一个返回数据的函数。数据加载后将立即在页面上可用。
config 一个描述此后端函数在 Toolpad Studio 中的功能的对象。请参阅 FunctionConfig

返回值

Toolpad Studio 可识别的函数

类型

FunctionConfig

这描述了自定义函数的行为。

属性

名称	类型	描述
`parameters?`	`{ [name: string]: ParameterDefinition }`	描述将在函数的 `parameters` 属性中传递的参数。请参阅 ParameterDefinition。

ParameterDefinition

这描述了将传递给自定义函数的参数类型。

属性

名称	类型	描述
`type?`	`'string' \| 'number' \| 'boolean' \| 'object' \| 'array'`	描述参数的类型。
`default?`	`any`	属性的默认值。
`helperText?`	`string`	简短的解释性文本，当引用此属性时，将在编辑器 UI 中显示。可能包含 Markdown。
`description?`	`string`	属性的描述，用于向用户提供额外信息。
`enum?`	`string[]`	仅适用于 `'string'` 类型。定义属性的有效值集。
`minimum?`	`number`	仅适用于 `'number'` 类型。定义属性的最小值。
`maximum?`	`number`	仅适用于 `'number'` 类型。定义属性的最大值。