gql-types-generator

gql-types-generator

Package to generate types depending on GraphQL scheme, mutations and queries.

Install

npm install --save gql-types-generator

yarn add gql-types-generator

Usage

gql-types-generator provides 2 ways of generating types:

1. Command line interface;
2. TypeScript / JavaScript code.

Command line interface

After installation of package is done, gql-types-generator command becomes available.

Usage: gql-types-generator [options] <schema-globs>

Options:
  --remove-description     states if we should remove description
  -s --sort <sort>         how to display compiled types. Valid values are "as-is" and "default". By default, generator compiles scalars first, then enums, interfaces, inputs, unions and then types. "as-is" places types as they are placed in schema
  -o --output-path <path>  path to file where typings will be saved
  -h, --help               display help for command

Programmatic control

If needed, you can use compile function to generate types.

Options

Current list of options

Name	Type	Description
removeDescription (optional)	boolean	Removes GraphQL descriptions
schema	string	String representation of schema. Can be used instead of source option
source	string	Glob to search schema partials. Can be used instead of schema option
sort (optional)	'as-is' or 'default'	States in what order display compiled types. By default, generator compiles scalars first, then enums, interfaces, inputs, unions and then types. as-is places types as they are placed in schema
outputPath	string	Full path to file where compiler should save types

Examples

When schema is separated between 2 directories:

import {compile} from 'gql-types-generator';
import * as path from 'path';

compile({
  source: [
    path.resolve(__dirname, 'schema-artifacts-folder-1/*.graphql'),
    path.resolve(__dirname, 'schema-artifacts-folder-2/*.graphql')
  ],
  outputPath: path.resolve(__dirname, 'types.d.ts'),
});

When all the schema partials are in the only 1 directory:

compile({
  source: path.resolve(__dirname, 'schema-artifacts/*.graphql'),
  outputPath: path.resolve(__dirname, 'types.d.ts'),
});

When you already have schema as text:

compile({ 
  schema: 'type Query { ... }',
  outputPath: path.resolve(__dirname, 'types.d.ts'),
});

When you want to sort schema types as they are placed in original GQL schema:

compile({
  source: path.resolve(__dirname, 'schema-artifacts/*.graphql'),
  outputPath: path.resolve(__dirname, 'types.d.ts'),
  sort: 'as-is'
});