@timkendall/tql NPM

TQL

Note: this is pre-production software at this point, see the current limitations.

tql is a TypeScript GraphQL query builder.

Codegen once - regenerate your GraphQL API client only when your schema changes.
Fully type-safe - take advantage of the full power of TypeScript's advanced type-system.
Backendless - integrate with any existing GraphQL client.

Try it Out

Try out our pre-compiled Star Wars GraphQL client on Repl.it!

Installation

npm install @timkendall/tql

TypeScript 4.1+ is required for Recursive Conditional Type support

Usage

You will need to compile a type-safe client one time before using. Do this with the provided CLI:

npx @timkendall/tql-gen <schema> > api.ts

import { useQuery } from '@apollo/client'

// SDK generated in previous setup
import { query, $ } from './starwars'

const QUERY = query((t) => [
  t.reviews({ episode: Episode.EMPIRE }, (t) => [
    t.stars(),
    t.commentary(),
  ]),

  t.human({ id: $('id') }, (t) => [
    t.__typename(),
    t.id(),
    t.name(),
    t.appearsIn(),
    t.homePlanet(),

    // @note Deprecated field should be properly picked-up by VSCode!
    t.mass(),

    t.friends((t) => [
      t.__typename(),
      t.id(),
      t.name(),
      t.appearsIn(),

      t.on("Human", (t) => [t.homePlanet()]),
      t.on("Droid", (t) => [t.primaryFunction()]),
    ]),

    t.starships((t) => [t.id(), t.name()]),
  ]),
]).toQuery({ name: 'Example' })

// type-safe result and variables 👍
const { data } = useQuery(QUERY, { variables: { id: '1011' }})