Rivet API 参考文档

Rivet文档的这一部分介绍了@ironclad/rivet-core和@ironclad/rivet-node的TypeScript API。

要开始将Rivet集成到您现有的TypeScript或JavaScript应用程序中，请参阅Integration - Getting Started页面。

@ironclad/rivet-core​

Rivet core 是一个纯 ESM 包，包含核心 Rivet API。它不依赖于浏览器或 node.js API，可以在任何支持现代 ESM 的 JavaScript 环境中使用，包括像 PythonMonkey 这样的嵌入式环境。

Rivet应用程序使用Rivet核心直接在应用程序中运行图形。

更多信息请参阅Rivet核心概述。

@ironclad/rivet-node​

Rivet节点是Rivet核心的Node.js绑定。它包含辅助API，用于从文件系统加载rivet图并执行它们。

在您的应用程序中，您很可能希望使用Rivet节点。Rivet核心的所有类型都从Rivet节点重新导出，因此您可以将Rivet节点作为Rivet核心的直接替代品使用。

更多信息请参阅Rivet节点概览。

@ironclad/rivet-cli​

Rivet CLI是一个命令行界面工具，用于从命令行运行Rivet图表。它构建在Rivet节点之上，提供了从命令行运行图表的便捷方式，以及一个本地HTTP服务器用于通过HTTP请求运行图表。

更多信息请参阅Rivet CLI概述。

系统要求​

Rivet节点需要Node.js 16或更高版本。