Skip to content

Latest commit

 

History

History
87 lines (60 loc) · 2.68 KB

README.md

File metadata and controls

87 lines (60 loc) · 2.68 KB
Raw

TQL

🚧 This is fork is intended to be a continuation of @timkendall/tql which is no longer under development.

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-js is our single runtime (peer) dependency.

Try it Out

Try out our pre-compiled Star Wars GraphQL SDK on CodeSandbox!

Installation

  1. npm install @lorefnon/tql@beta

  2. Generate an SDK with npx @lorefnon/tql-gen <schema> -o sdk.ts

<schema> can be a path to local file or an http endpoint url.

Usage

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) =>
      [
        t.__typename(),

        ...CHARACTER,
        // or
        CHARACTER.toInlineFragment(),

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

    t.starships((t) => [t.id(), t.name()]),
  ]),
]).build({ name: "Example" });

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

Inspiration

I was inspired by the features and DSL's of graphql-nexus, graphql_ppx, gqless, and caliban.

License

MIT