跳至主要内容
版本: v18.0.0

已弃用

GraphQL 允许您将字段标记为 @deprecated 并提供可选的人类可读原因。Relay 解析器将此相同的约定引入您的客户端数据。通过将客户端状态模式中的字段标记为已弃用,它们将与服务器 GraphQL 模式中已弃用字段的处理方式相同。

已弃用字段在 Relay 的 VSCode 扩展 中的自动完成和悬停时会显示为已弃用。此外,它们在编辑器中将呈现为灰显并 删除线

信息

预计 GraphQL 弃用原因将以 Markdown 编写。Relay 解析器将在 VSCode 扩展中以 Markdown 形式渲染这些描述。

您可以通过添加 @deprecated 文档块标签(后跟可选文本以指定原因)来将字段标记为已弃用。

/**
* @RelayResolver Author.fullName: String
*
* @deprecated Google "Falsehoods Programmers Believe About Names"
*/
export function fullName(author: AuthorModel): string {
return `${author.firstName} ${author.lastName}`;
}