Descriptions

One killer feature of GraphQL is that makes the data in your schema discoverable. Relay Resolvers bring this structure to your client data. By adding descriptions to your resolvers you can make your client state schema self-documenting as well.

Descriptions are surfaced by Relay's VSCode extension in autocomplete and on hover.

You can add a description to a type by adding free text to the docblock tag:

info

GraphQL descriptions are expected to be written in markdown. Relay Resolvers will render these descriptions as markdown in the VSCode extension.

Types

/**
 * @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);
}

Fields

/**
 * @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}`;
}