Usage

@defer is a GraphQL directive which instructs the server to execute the field in a special way:

query GetPlayerInfo($handle: String!){
  player(handle: $handle) {
    name
    # Send this field later, to avoid slowing down the initial response:
    topScore(from: 2000, to: 2020) @defer
  }
}

The directives @skip and @include are built into any GraphQL server and client, but @defer requires special attention.

Apollo-Client currently supports the @defer directive.

@defer also accepts a label: option which will be included in outgoing patches when it's present in the query (eg, @defer(label: "patch1")).

Want to use @defer with another client? Please {% open_an_issue "Client support for @defer with ..." %} or email [email protected] and we'll dig in!

Next Steps

{% internal_link "Set up your server", "/defer/setup" %} to support @defer.