cmslewis/gql.tada

🪄 Magical GraphQL query engine for TypeScript

gql.tada 🪄

Magical GraphQL query engine for TypeScript

gql.tada is a GraphQL document authoring library, inferring the result and variables types of GraphQL queries and fragments in the TypeScript type system. It derives the types for your GraphQL queries on the fly allowing you to write type-safe GraphQL documents quickly.

In short, gql.tada,

• parses your GraphQL documents in the TypeScript type system
• uses your introspected schema and scalar configuration to derive a schema
• maps your GraphQL queries and fragments with the schema to result and variables types
• creates fragment masks and enforces unwrapping fragments gradually

Since this is all done in the TypeScript type system and type checker, this all happens while you edit your GraphQL front-end code and is always accurate.

In short, with gql.tada and GraphQLSP you get on-the-fly, automatically typed GraphQL documents with full editor feedback, auto-completion, and type hints!

📃 Documentation

Check out the “Get Started” section’s Installation page in the documentation.

• Get Started
  • Introduction — everything you need to know
  • Installation — an installation guide
  • Writing GraphQL — how to write GraphQL documents
• API Reference
  • gql.tada API — gql.tada API Reference docs
  • gql.tada CLI — gql.tada CLI Reference docs
  • Config Format — Configuration Reference docs

Furthermore, all APIs and packages are self-documented using TSDocs. If you’re using a language server for TypeScript, the documentation for each API should pop up in your editor when hovering gql.tada’s code and APIs.

🔎 Let’s take a look!

💙 Sponsors

BigCommerce

WunderGraph

The Guild

BeatGig

📦 Releases

If you'd like to get involved, check out our Contributor's guide.

All new releases and updates are listed on GitHub with full changelogs. The CHANGELOG.md file further documents all the historical changes for gql.tada.

New releases are prepared using changesets, which are changelog entries added to each PR, and we have “Version Packages” PRs that once merged will release new versions of the gql.tada package. You can use @canary releases from npm if you’d like to get a preview of the merged changes.