@zbanx/graphql-gen

README

Generate TypeScript types from GraphQL schema.

Note: This tool only convert OBJECT, INPUT_OBJECT and ENUM.

Usage

Install:

pnpm i @zbanx/graphql-gen

Create a config file ./graphql-gen.yaml:

# shared type mapping for all endpoints
typeMapping:
  ID: 'number'
  Int: 'number'
  String: 'string'
  Boolean: 'boolean'
  Cursor: 'string'

# array of endpoints
# endpoint: where to fetch schema
# output: where to save generated file (relative to the config file)
# namesOutput: (optional) where to save the query and mutation names (relative to the config file)
# comment: (optional) comment to be added at the top of the file (string or array of string)
# headers: (optional) the http request headers to set on fetching schema
# headersYaml: (optional) external header config file (will override the headers)
# printHeaders: (optional) print headers in the console
# typeMapping: (optional) extra type mapping (override the shared one)
endpoints:
  - endpoint: https://www.exmaple.com/graphql
    output: ./types/graphql.ts
    comment: 'This file was automatically generated and should not be edited.'
    headers: {}
    headersYaml: ./headers.yaml
    printHeaders: false
    typeMapping:`
      Time: 'string'

Run the command:

npx graphql-gen --config graphql-gen.yaml