@graphql-codegen/typescript-resolvers

What is @graphql-codegen/typescript-resolvers?

@graphql-codegen/typescript-resolvers is a plugin for GraphQL Code Generator that generates TypeScript typings for your GraphQL resolvers. This helps in ensuring type safety and better developer experience when working with GraphQL APIs in TypeScript.

What are @graphql-codegen/typescript-resolvers's main functionalities?

Generate TypeScript Resolver Types

This feature allows you to generate TypeScript types for your GraphQL resolvers based on your GraphQL schema. The generated types help in ensuring that your resolvers adhere to the schema, providing type safety and reducing runtime errors.

const config = {
  schema: 'path/to/your/schema.graphql',
  generates: {
    'path/to/output.ts': {
      plugins: ['typescript', 'typescript-resolvers']
    }
  }
};

// Run the codegen
import { generate } from '@graphql-codegen/cli';
generate(config).then(() => {
  console.log('Types generated successfully!');
});

Custom Scalars Mapping

This feature allows you to map custom scalars in your GraphQL schema to specific TypeScript types. This is useful when you have custom scalar types like DateTime or JSON in your schema and you want to ensure they are correctly typed in TypeScript.

const config = {
  schema: 'path/to/your/schema.graphql',
  generates: {
    'path/to/output.ts': {
      plugins: ['typescript', 'typescript-resolvers'],
      config: {
        scalars: {
          DateTime: 'Date',
          JSON: 'any'
        }
      }
    }
  }
};

// Run the codegen
import { generate } from '@graphql-codegen/cli';
generate(config).then(() => {
  console.log('Types generated with custom scalars!');
});

Context Type

This feature allows you to specify a custom context type for your resolvers. The context type is often used to pass shared data like authentication information or database connections to your resolvers. By specifying the context type, you ensure that your resolvers have access to the correct context properties.

const config = {
  schema: 'path/to/your/schema.graphql',
  generates: {
    'path/to/output.ts': {
      plugins: ['typescript', 'typescript-resolvers'],
      config: {
        contextType: './my-context#MyContext'
      }
    }
  }
};

// Run the codegen
import { generate } from '@graphql-codegen/cli';
generate(config).then(() => {
  console.log('Types generated with custom context type!');
});

Other packages similar to @graphql-codegen/typescript-resolvers

graphql-codegen-typescript

graphql-codegen-typescript is another plugin for GraphQL Code Generator that generates TypeScript typings for your GraphQL operations and schema. While it focuses on generating types for the schema and operations, it does not specifically generate resolver types like @graphql-codegen/typescript-resolvers.

graphql-tools

graphql-tools is a set of utilities from Apollo that includes schema stitching, mock server, and schema generation. It provides some type safety features but does not generate TypeScript resolver types directly. It is more focused on schema creation and manipulation.

type-graphql

type-graphql is a library that allows you to create GraphQL schemas using TypeScript classes and decorators. It provides a different approach to type safety by leveraging TypeScript's type system directly in the schema definition, rather than generating types from an existing schema.

README

The README file is missing