TypeScript Academy · Leçon

Résolveurs typés avec GraphQL Code Generator

Écrivez des résolveurs avec les bons types d’entrée et de retour

Résolveurs typés avec GraphQL Code Generator est une leçon TypeScript Academy gratuite sur CoddyKit. Ceci est la leçon 2 sur 4. Tu peux lire la leçon complète ci-dessous gratuitement — puis la pratiquer en direct dans le navigateur avec un éditeur de code intégré et un tuteur IA 24/7. Elle fait partie du parcours d'apprentissage TypeScript Academy, et ta progression se synchronise sur le web et l'application CoddyKit. Le cours TypeScript Academy comprend 4 leçons au total.

Le problème du typage des résolveurs

Les résolveurs GraphQL sont de simples fonctions, mais sans signatures typées, il est facile de renvoyer des structures incorrectes. La génération de code produit des types de résolveurs qui garantissent des valeurs de retour correctes.

// Without typed resolvers — any type allowed
const userResolver = async (_, { id }) => fetchUser(id);

Ajouter le module des résolveurs

Installez et configurez @graphql-codegen/typescript-resolvers pour générer les types de table de correspondance des résolveurs.

npm install --save-dev @graphql-codegen/typescript-resolvers

codegen.yml pour les résolveurs

Ajoutez la sortie du module des résolveurs à côté des types TypeScript de base.

# codegen.yml
generates:
  src/generated/types.ts:
    plugins:
      - typescript
  src/generated/resolvers.ts:
    plugins:
      - typescript-resolvers

Utiliser le ResolverMap généré

Appliquez le type Resolvers généré à votre objet de mappage des résolveurs pour bénéficier d’une sécurité complète des types.

import { Resolvers } from "./generated/resolvers";

const resolvers: Resolvers = {
  Query: {
    user: async (_, { id }) => fetchUser(id),
    // Return type enforced: must match User schema
  },
};

Typage du contexte

Transmettez votre type de contexte au paramètre générique de Resolvers afin que les fonctions de résolution reçoivent un objet de contexte correctement typé.

interface Context { db: Database; user?: AuthUser; }

// codegen.yml
config:
  contextType: "src/context#Context"

// Generated: Resolvers<Context>
const resolvers: Resolvers<Context> = {
  Query: {
    me: (_, __, ctx) => ctx.user, // ctx: Context
  },
};

Types de mappage

Les types de mappage vous permettent d’associer les types GraphQL à vos types de modèles internes, afin que les résolveurs puissent renvoyer vos objets métier plutôt que les types de sortie GraphQL.

# codegen.yml
config:
  mappers:
    User: "src/models#UserModel"

Typage des résolveurs de champs

Les résolveurs individuels des champs sont eux aussi typés, y compris leurs arguments parent et contexte.

// Typed field resolver on User type
const resolvers: Resolvers<Context> = {
  User: {
    fullName: (parent) => `${parent.firstName} ${parent.lastName}`,
    // parent is UserModel (from mapper)
  },
};

Mutations typées

Les résolveurs de mutation reçoivent des arguments d’entrée typés, dérivés des types d’entrée du schéma.

// Schema: createUser(input: CreateUserInput!): User!
const resolvers: Resolvers = {
  Mutation: {
    createUser: (_, { input }) => {
      // input: CreateUserInput — fully typed
      return createUser(input.name, input.email);
    },
  },
};

Souscriptions typées

Les résolveurs de souscription possèdent une fonction subscribe et une fonction resolve, toutes deux typées par le générateur de code.

const resolvers: Resolvers = {
  Subscription: {
    messageAdded: {
      subscribe: () => pubsub.asyncIterator("MESSAGE_ADDED"),
      resolve: (payload) => payload.messageAdded, // typed
    },
  },
};

Maintenir la synchronisation de la génération de code

Ajoutez un crochet exécuté avant la compilation ou avant la validation pour régénérer les types de résolveurs lorsque le schéma change et empêcher les types obsolètes d’atteindre la production.

// package.json
{
  "scripts": {
    "predev": "graphql-codegen",
    "prebuild": "graphql-codegen"
  }
}

Récapitulatif : résolveurs typés

Le module de génération de code typescript-resolvers produit un type Resolvers qui impose des structures de retour correctes, des types d’arguments appropriés et une structure de contexte cohérente pour tous vos résolveurs GraphQL.

Vérification rapide

Que fait l’option de configuration contextType dans le générateur de code ?

Ce que vous avez appris

Les résolveurs GraphQL typés avec la génération de code imposent des types de retour corrects, des structures d’arguments appropriées et des objets de contexte cohérents dans toute votre table de correspondance de résolveurs. Utilisez les types de mappage pour les objets métier et intégrez la génération de code à votre chaîne de compilation pour éviter les divergences.

Questions Fréquemment Posées

La leçon « Résolveurs typés avec GraphQL Code Generator » est-elle gratuite ?

Oui — le texte complet de « Résolveurs typés avec GraphQL Code Generator » est gratuit à lire ici sur le web. Pour la pratiquer de manière interactive (un éditeur de code intégré et un tuteur IA 24/7) et déverrouiller le reste du cours TypeScript Academy, passe à CoddyKit PRO. Le cours TypeScript Academy comprend 4 leçons au total.

Qu'est-ce que j'apprendrai dans « Résolveurs typés avec GraphQL Code Generator » ?

Écrivez des résolveurs avec les bons types d’entrée et de retour Tu pratiques TypeScript Academy avec du code pratique que tu exécutes directement dans le navigateur, et un tuteur IA 24/7 répond à tes questions au fur et à mesure que tu avances dans la leçon.

Dois-je avoir de l'expérience pour commencer TypeScript Academy ?

Aucune expérience préalable n'est requise. TypeScript Academy sur CoddyKit est structuré pour les débutants jusqu'aux apprenants avancés, donc tu peux commencer ici ou depuis le début et avancer à ton rythme. Ceci est la leçon 2 sur 4.

Combien de temps prend la leçon « Résolveurs typés avec GraphQL Code Generator » ?

La plupart des leçons CoddyKit prennent environ 5–10 minutes. Chacune est courte et interactive, tu progresses régulièrement et tu repiques exactement où tu t'es arrêté sur le web et l'app.

Peux-tu écrire et exécuter du code dans cette leçon TypeScript Academy ?

Oui. Chaque leçon TypeScript Academy inclut un éditeur de code intégré, tu écris et exécutes du vrai code directement dans ton navigateur et tu reçois des retours IA instantanés — aucune configuration locale requise.

Toutes les leçons de ce cours

Schéma GraphQL vers types TypeScript
Résolveurs typés avec GraphQL Code Generator
Client GraphQL typé avec Apollo et urql
Sûreté des types de bout en bout : flux de travail fondé sur le schéma

← Retour à TypeScript Academy