Vilken strikt TypeScript-typ ska returneras från GraphQL-resolver med ESLint?

repo

https://github.com/inspiraller/apollo-typescript

Koden körs men Eslint TypeScript klagar ändå.

Jag får eslint-fel på:

 Query: {
    players: () => players
  }

Saknas returtyp på funktionen.eslint@typescript-eslint/explicit-module-boundary-types

index.ts

import { ApolloServer } from 'apollo-server';
import typeDefs from './schema';
import resolvers from './resolvers';

const init = () => {
  const server: ApolloServer = new ApolloServer({
    typeDefs,
    resolvers
  });

  server.listen().then((props: { url: string }) => {
    const { url } = props;
    console.log(`Server ready at ${url}`);
  });
};

init();

schema.ts

import { gql } from 'apollo-server';

const typeDefs = gql`
  type Player {
    id: String
    name: String
  }
  type Query {
    players: [Player]!
  }

  input PlayerInput {
    name: String
  }

  type Mutation {
    addPlayer(player: PlayerInput!): Player
  }
`;

export default typeDefs;

resolvers.ts

interface shapePlayer {
  id: string;
  name: string;
}
const players: Array<shapePlayer> = [
  {
    id: 'alpha',
    name: 'terry'
  },
  {
    id: 'beta',
    name: 'pc'
  }
];

interface shapeResolver {
  Query: {
    players: () => Array<shapePlayer> | null | undefined | void;
  };
}

const resolvers: shapeResolver = {
  Query: {
    players: () => players
  }
};
export default resolvers;

Jag har upptäckt många alternativa bibliotek att använda, t.ex. typegraphql, och detta verkar vara en bra lösning för att minska boilerplate TypeScript-typer, men det ger inte svaren på vad den strikta returtypen för en fråga eller mutation är.

All hjälp rekommenderas. Tack

Svar #1

Kanske är det lite sent men hoppas att det också hjälper någon annan.

Jag har hittat det bästa sättet att automatiskt få typdefinitioner för TS från ditt schema med graphql-code-generator

För ett snabbt svar, klistra in ditt schema här.

Snabb installation för typescript:

  1. Installera
npm i -D @graphql-codegen/cli @graphql-codegen/typescript @graphql-codegen/typescript-resolvers

Det kommer att installera CLI och TypeScript + TypeScript-resolvers-plugins.

  1. I din rot skapa codegen.yml och lägg i:
overwrite: true
schema: 'http://localhost:3500/graphql'
generates:
  src/utils/codegen/graphql.ts:
    plugins:
      - 'typescript'
      - 'typescript-resolvers'
  1. utför kommando:
graphql-codegen --config codegen.yml --watch src/**/*.ts
  1. Nu kan du göra något på följande sätt:
// Import the types of your generated ts file.
import { MutationResolvers, QueryResolvers, Resolvers } from '@/utils/codegen/graphql'

const Query: QueryResolvers = {
  players: () => players
}

const Mutation: MutationResolvers = {
  updatePlayer: () => player
}

const resolvers: Resolvers = {
  Query,
  Mutation
};
export default resolvers;

Exempel på skärmdumpar:

intellisense och autokomplettering

korrekt validering

Relaterade artiklar