廃止

GraphQLを使用すると、フィールドを@deprecatedとしてマークし、オプションの人間が読める理由を提供できます。Relayリゾルバーは同じ規約をクライアントデータにもたらします。クライアントステートスキーマ内のフィールドを廃止とマークすると、サーバーGraphQLスキーマ内の廃止フィールドと同じ扱いを受けます。

廃止されたフィールドはRelayのVSCode拡張機能のオートコンプリートとホバー上でそのような形で表示されます。さらに、エディター内でグレー表示され、打ち消し線付き表示されます。

情報

GraphQL廃止の理由はマークダウンで書かれることが想定されています。Relayリゾルバーはこれらの説明をVSCode拡張機能でマークダウンとしてレンダリングします。

フィールドを廃止するには、@deprecatedDocblockタグの後にオプションでテキストを続けて理由を指定して追加します。

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