描述

GraphQL 的一个杀手级功能是它使您在模式中可发现数据。中继解析器将这种结构带到您的客户端数据中。通过在您的解析器中添加描述，您可以使您的客户端状态模式也成为自文档化的。

描述由中继的 VSCode 扩展 在自动完成和悬停时显示。

您可以通过将自由文本添加到 docblock 标记来向类型添加描述

信息

预计 GraphQL 描述将以 Markdown 编写。中继解析器将在 VSCode 扩展中以 Markdown 形式呈现这些描述。

类型

/**
 * @RelayResolver Author
 *
 * An author in our **amazing** CMS. Authors can
 * write posts but not necessarily change their permissions.
 */
export function Author(id: DataID): AuthorModel {
  return AuthorService.getById(id);
}

字段

/**
 * @RelayResolver Author.fullName: String
 *
 * The author's first and last name. Does not include
 * any [honorifics](https://en.wikipedia.org/wiki/Honorific).
 */
export function fullName(author: AuthorModel): string {
  return `${author.firstName} ${author.lastName}`;
}