Question 1

How to set up ts-graphql-plugin with a remote GraphQL schema using authentication?

Accepted Answer

Configure the 'schema' option in tsconfig.json with an HTTP object containing the URL and headers. For dynamic tokens, use a JavaScript script via 'fromScript' that returns a RequestSetup object, as detailed in the README's schema configuration examples.

Question 2

ts-graphql-plugin vs GraphQL Code Generator: which is better for type safety?

Accepted Answer

ts-graphql-plugin excels at real-time editor integration and Language Service features for in-IDE feedback, while GraphQL Code Generator is more comprehensive for build-time type generation and plugin ecosystems. Choose based on whether you prioritize immediate editor tooling or automated code generation workflows.

Question 3

How to generate TypeScript types from GraphQL queries in my project?

Accepted Answer

After configuring the plugin in tsconfig.json, use the CLI 'typegen' command to scan TypeScript sources for GraphQL operations and output type definitions. The README provides an example of the generated file structure and usage with addons for enhanced typing.

Question 4

Does ts-graphql-plugin work with React and Apollo Client for queries?

Accepted Answer

Yes, it's designed for GraphQL client development and integrates with frameworks like React. The README includes examples using the typed-query-document addon to create TypedQueryDocumentNode types for Apollo Client's useQuery, ensuring full type safety.

Question 5

Why isn't the webpack transformer working in development watch mode?

Accepted Answer

This is a known limitation where the transformer does not operate when webpack's mode is 'development' and watch is enabled, as mentioned in the README. It's designed to avoid performance issues, so validation during development relies on the Language Service plugin instead.

Question 6

How to add custom scalar type mappings in type generation?

Accepted Answer

Create a custom addon by implementing TypeGenAddonFactory and specify it in the 'typegen.addons' option. The addon can map GraphQL scalar types to TypeScript types, as demonstrated in the built-in addons section for handling types like URL strings.

ts-graphql-plugin

What is ts-graphql-plugin?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions