已棄用
GraphQL 允許您將欄位標記為 @deprecated
,並提供可選的人類可讀原因。Relay 解析器將此相同慣例帶到您的客戶端資料。通過將客戶端狀態綱要中的欄位標記為已棄用,它們將獲得與伺服器 GraphQL 綱要中已棄用的欄位相同的待遇。
已棄用的欄位在 Relay 的 VSCode 擴充功能中,會在自動完成和懸停時顯示為此類。此外,它們將在編輯器中呈現為灰色,並以刪除線顯示。
資訊
GraphQL 棄用原因預期以 markdown 格式撰寫。Relay 解析器將在 VSCode 擴充功能中將這些描述呈現為 markdown。
您可以通过添加 @deprecated
docblock 標籤,後跟可選文字來指定原因,以將欄位標記為已棄用。
/**
* @RelayResolver Author.fullName: String
*
* @deprecated Google "Falsehoods Programmers Believe About Names"
*/
export function fullName(author: AuthorModel): string {
return `${author.firstName} ${author.lastName}`;
}