06
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
913 B
Operation text
—
What the browser sends
—
1 · You write
src/components/consistency/PostTitle.tsxfragment PostTitle_post on Post {
title
}2 · Types you import
PostTitle_post.graphql.tsexport type PostTitle_post$data = {
readonly title: string;
readonly " $fragmentType": "PostTitle_post";
};
export type PostTitle_post$key = {
readonly " $data"?: PostTitle_post$data;
readonly " $fragmentSpreads": FragmentRefs<"PostTitle_post">;
};3 · Runtime artifact
imported in place of the graphql`` tagA 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<<60171cbb92d96120306bd999b61d35ae>>
* @lightSyntaxTransform
*/
/* tslint:disable */
/* eslint-disable */
// @ts-nocheck
import { ReaderFragment } from 'relay-runtime';
import { FragmentRefs } from "relay-runtime";
export type PostTitle_post$data = {
readonly title: string;
readonly " $fragmentType": "PostTitle_post";
};
export type PostTitle_post$key = {
readonly " $data"?: PostTitle_post$data;
readonly " $fragmentSpreads": FragmentRefs<"PostTitle_post">;
};
const node: ReaderFragment = {
"argumentDefinitions": [],
"kind": "Fragment",
"metadata": null,
"name": "PostTitle_post",
"selections": [
{
"alias": null,
"args": null,
"kind": "ScalarField",
"name": "title",
"storageKey": null
}
],
"type": "Post",
"abstractKey": null
};
(node as any).hash = "0b4be2a42199d82183bbaaa462805b5c";
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
datatype 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.