Typisierte Resolver mit GraphQL Code Generator

Das Problem der Resolver-Typisierung

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

Das Resolvers-Plugin hinzufügen

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

codegen.yml für Resolver

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

Die erzeugte ResolverMap verwenden

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

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

Typisierung des Kontexts

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
  },
};

Mapper-Typen

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

Typisierung von Feld-Resolvern

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

Typisierte Mutationen

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

Typisierte Subscriptions

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

Codegen synchron halten

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

Rückblick: Typisierte Resolver

Kurzer Test

Das haben Sie gelernt