niieani / codegen-typescript-graphql-module-declarations-plugin

A codegen plugin - similar to the TypeScript GraphQL Files Modules Plugin, but uses typed nodes.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

codegen-typescript-graphql-module-declarations-plugin

This graphql-code-generator plugin is based on the TypeScript GraphQL Files Modules, but generates typed document nodes, using the types generated earlier by TypedDocumentNode plugin.

You need to run graphql-code-generator with the TypedDocumentNode plugin first and set typedDocumentNodeModule option to the module path of the generated file.

For configuration options see index.ts.

This plugin generates TypeScript typings for .graphql files containing GraphQL documents, which later on can be consumed using graphql-tag/loader or use string types if you will use the operations as raw strings, and get type-check and type-safety for your imports. This means that any time you import objects from .graphql files, your IDE will provide auto-complete.

This plugin also handles .graphql files containing multiple GraphQL documents, and name the imports according to the operation name.

⚠ Fragments are not generated with named imports, only as default imports, due to graphql-tag/loader behavior.

About

A codegen plugin - similar to the TypeScript GraphQL Files Modules Plugin, but uses typed nodes.

License:MIT License


Languages

Language:TypeScript 93.1%Language:Shell 5.9%Language:JavaScript 1.0%