Warning: This library will not be recieving updates any time soon.
🙏 Thank you to all contributors. I am not interested in maintaining this right now but please feel free to fork and take inspiration from!
tql is a TypeScript GraphQL query builder.
- 🔒 Fully Type-safe - Operation results and variables are fully type-safe thanks to TypeScript's advanced type-system.
- 🔌 Backendless: - Integrate with any GraphQL client to execute queries.
- 🔮 Automatic Variables: - Variable definitions are automatically derived based on usage.
- 📝 Inline Documentation: JSDoc comments provide descriptions and deprecation warnings for fields directly in your editor.
- ⚡ Single Dependency:
graphql-jsis our single runtime (peer) dependency.
Try out our pre-compiled Star Wars GraphQL SDK on CodeSandbox!
-
npm install @timkendall/tql@beta- TypeScript 4.1+ is required for Recursive Conditional Type support
-
Generate an SDK with
npx @timkendall/tql-gen <schema> -o sdk.ts
<schema> can be a path to local file or an http endpoint url.
Import selector functions to start defining queries 🎉
import { useQuery } from '@apollo/client'
// SDK generated in previous setup
import { character, query, $ } from './starwars'
// define reusable selections
const CHARACTER = character(t => [
t.id(),
t.name(),
t.appearsIn(),
])
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(),
// deprecated field should be properly picked-up by your editor
t.mass(),
t.friends((t) => <const>[
t.__typename(),
...CHARACTER,
// or
CHARACTER.toInlineFragment(),
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' }})I was inspired by the features and DSL's of graphql-nexus, graphql_ppx, gqless, and caliban.
MIT