The compiler does the work before your app runs

relay-compiler reads every graphql tag in the project, validates it against schema.graphql, and writes an artifact per fragment and operation: a precomputed runtime AST, TypeScript types, and (here) a persisted query id. Pick any artifact this app generated.

Kind

fragment

Artifact size

1.4 KB

Operation text

—

What the browser sends

—

1 · You write

src/components/advanced/RequiredCatchDemo.tsx

fragment RequiredCatchDemo_user on User {
  name
  avatarColor
  website @required(action: NONE)
}

2 · Types you import

RequiredCatchDemo_user.graphql.ts

export type RequiredCatchDemo_user$data = {
  readonly avatarColor: string;
  readonly name: string;
  readonly website: string;
  readonly " $fragmentType": "RequiredCatchDemo_user";
} | null | undefined;
export type RequiredCatchDemo_user$key = {
  readonly " $data"?: RequiredCatchDemo_user$data;
  readonly " $fragmentSpreads": FragmentRefs<"RequiredCatchDemo_user">;
};

3 · Runtime artifact

imported in place of the graphql`` tag

A preprocessed AST, so there's no GraphQL parsing in the browser. The reader part tells useFragment what to read; the normalization part tells the store how to write.

/**
 * @generated SignedSource<<efe1450e1ea4b5f4abe28679ea15f12e>>
 * @lightSyntaxTransform
 */

/* tslint:disable */
/* eslint-disable */
// @ts-nocheck

import { ReaderFragment } from 'relay-runtime';
import { FragmentRefs } from "relay-runtime";
export type RequiredCatchDemo_user$data = {
  readonly avatarColor: string;
  readonly name: string;
  readonly website: string;
  readonly " $fragmentType": "RequiredCatchDemo_user";
} | null | undefined;
export type RequiredCatchDemo_user$key = {
  readonly " $data"?: RequiredCatchDemo_user$data;
  readonly " $fragmentSpreads": FragmentRefs<"RequiredCatchDemo_user">;
};

const node: ReaderFragment = {
  "argumentDefinitions": [],
  "kind": "Fragment",
  "metadata": null,
  "name": "RequiredCatchDemo_user",
  "selections": [
    {
      "alias": null,
      "args": null,
      "kind": "ScalarField",
      "name": "name",
      "storageKey": null
    },
    {
      "alias": null,
      "args": null,
      "kind": "ScalarField",
      "name": "avatarColor",
      "storageKey": null
    },
    {
      "kind": "RequiredField",
      "field": {
        "alias": null,
        "args": null,
        "kind": "ScalarField",
        "name": "website",
        "storageKey": null
      },
      "action": "NONE"
    }
  ],
  "type": "User",
  "abstractKey": null
};

(node as any).hash = "21586570e89f7edc4421f3e508c715d8";

export default node;

why it mattersA typo in a field name fails the build, not the user's session. Every fragment is checked against the schema on every save.
why it mattersTypes come from the fragment rather than the whole schema, so a component's data type has exactly the fields it asked for.
why it mattersPersisted queries ship for free: smaller requests, cacheable GETs, and a server that can refuse any query it didn't compile.