參考API 參考

API 參考

此參考嘗試記錄 Svelte Flow 所輸出的每個函式、hook、元件和類型。如果您正在尋找指南,請參考我們的學習區塊

💡

此套件目前處於 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 表示該類型是 TU:這通常稱為聯集

T & U 表示該類型是 TU:這通常稱為交集

TypeScript 的人員有他們自己的閱讀類型方便指南,您可能會覺得有用。如果您仍然對某些事情感到困惑,請隨時加入我們的 Discord 並尋求協助!