Schema Loader CLI

Generate Schema Types

There are two ways to generate schema types: command line and programmatic.

Command Line

For most cases you just need to run the command line tool to generate the schema types.

The config will save at gqfn.config.json.

pnpm run gqfn add https://graphql.anilist.co

If the schema updated, you can use the sync command to reload all schema.

pnpm run gqfn sync

Learn more about the Command Line.

Programmatic

You can import the generator if you want to control the schema types generation.

import {  } from '@gqfn/core/cli'

const  = await ({
  : ['https://graphql.anilist.co'],
  : 'src/gqfn',
  : true, // disable logger
})

// write to file

Learn more about the Programmatic Usage.

useSchema

After generating the schema types, you can use the useSchema to get the typed gqfn or gqp.

const { , ,  } = ('https://graphql.anilist.co')

const  = ('query FetchAnime', {
  : 'Int!',
}, [{
  :  => ({ : ., : ('ANIME') }, [
    'id',
    {
      :  => ([
        'romaji',
        'english',
        'native',
      ]),
    },
  ]),
}])

If you manually write your schema type, you can configure it to use in useSchema.

export type Schema = DefineSchema<{
  // Your schema type
}>

declare module '@gqfn/core/schema' {
  interface Schemas {
    'https://your-endpoint-url': Schema
  }
}