API 概览
这是@ironclad/rivet-node
Node.js库的API概览。api.ts
文件中的每个导出项都在其自己的页面中进行了文档说明,如下链接所示:
系统要求
Rivet节点需要Node.js 16或更高版本。
核心
为方便起见,从@ironclad/rivet-core
导出的所有类型和方法都会通过@ironclad/rivet-node
重新导出。更多信息请参阅核心API概览。
当然,我可以帮你解决这个问题。以下是更新API概览的方法:
功能
- loadProjectFromFile: 此函数从给定的文件路径加载项目。
- loadProjectFromString: 此函数从字符串内容加载项目。
- runGraphInFile: 此函数使用提供的选项在文件中运行图形。
- createProcessor: 该函数为指定项目创建一个具有特定选项的处理器。
- runGraph: 此函数使用特定选项为给定项目运行图形。
- startDebuggerServer: 此函数使用提供的选项启动调试器服务器。
类型
- LooseDataValue: 该类型表示一个松散的数据值,可以是
DataValue
、string
、number
或boolean
。 - RunGraphOptions: 此类型表示运行图时可提供的选项。
- RivetDebuggerServer: 此类型表示一个调试器服务器实例,包含一个WebSocketServer及多个用于处理事件和处理器交互的方法。
- DebuggerEvents: 此类型表示调试器服务器可以发出的事件。
请访问每个页面以获取有关每种导出的详细信息,包括使用示例和类型定义。