createHandler API

在自定义服务器中以编程方式运行 Toolpad Studio 应用程序。

导入

import { createHandler } from '@toolpad/studio';

const toolpad = await createHandler(config);

一个 Promise，用于 Toolpad Studio 应用程序对象，该对象公开一个可以附加到 node.js http 服务器的处理程序。请参阅 Handler

这描述了自定义处理程序的行为。

属性

名称	类型	描述
`base`	`string`	处理程序将托管在的基础路径。
`dev`	`boolean`	在开发模式下运行处理程序。只有在此模式下才能附加独立编辑器。
`dir`	`string`	Toolpad Studio 应用程序定义将存储在的目录。默认情况下，将是相对于当前工作目录的 `./toolpad` 文件夹。

这是 createHandler 函数的返回值。

属性

名称	类型	描述
`handler`	`(req: IncomingMessage, res: ServerResponse) => void`	node.js 请求处理程序。
`dispose`	`() => Promise<void>`	调用此方法以释放自定义处理程序并释放其所有已用资源。