参考API 参考

API 参考

本参考试图记录 Svelte Flow 导出的每个函数、钩子、组件和类型。如果你正在寻找指南,请参阅我们的 学习部分.

💡

此包目前处于 alpha 阶段,正在积极开发中。API 可能会发生变化。你可以在 “最新消息”部分 阅读关于最新更改的信息。

如何使用本参考

我们认为,文档应该回答两个广泛的问题:“这是什么?”和“如何使用它?”

为此,我们的 API 参考旨在**简洁地**回答第一个问题,而指南则更详细地介绍第二个问题。如果你发现自己浏览参考并想知道这些内容究竟是什么意思,也许我们有指南可以帮助你!

JavaScript 用户注意

Svelte Flow是用 TypeScript 编写的,但我们知道并不是每个人都使用它。我们鼓励开发人员使用最适合他们的技术,并且在我们的文档中,TypeScript 和 JavaScript 示例都有。

但是,对于我们的 API 参考,我们使用 TypeScript 的语法来记录道具和函数的类型。以下是如何快速阅读它的简要课程

? 表示该字段或参数是可选的。

• 在类型定义中,<T> 表示一个泛型类型参数。就像函数参数,但针对类型!定义 type Array<T> = ... 表示一个名为 Array 的类型,它接受一个泛型类型参数 T

• 当引用类型时,<T> 就像“填充”泛型类型参数一样。它就像调用函数,但针对类型!类型 Array<number> 是类型 Array,其泛型类型参数 T 用类型 number 填充。

T | U 表示该类型要么是 T,要么是 U:这通常称为联合

T & U 表示该类型既是 T,又是 U:这通常称为交集

TypeScript 团队有他们自己的 阅读类型的便捷指南,你可能会发现它很有用。如果你仍然对某些内容感到困惑,请随时访问我们的 Discord 并寻求帮助!