Code Monkey home page Code Monkey logo

nitrogql's Introduction

nitrogql logo

GraphQL + TypeScript. Done right.

Documentation

nitrogql

nitrogql is a toolchain for using GraphQL in TypeScript projects. Main features include:

Type generation with sourcemap support.

nitrogql generates TypeScript types for your GraphQL schema and queries. It also generates a sourcemap file that maps the generated types to the original GraphQL schema and queries. With sourcemaps, you will never see generated code in your IDE, and you will always be able to jump to the original source code.

VSCode's "Peek Definition" command showing the original GraphQL query

Static check for GraphQL code.

nitrogql can check your GraphQL code statically and guard you from any runtime errors caused by type mismatch.

Result of running nitrogql check on a sample project

Installation

Install the nitrogql CLI with npm:

npm install --save-dev @nitrogql/cli

The CLI will enable you to check GraphQL files and generate types. Read more about the CLI in the CLI documentation.

To use GraphQL in your front-end project, you will also need to install appropriate loader.

For webpack-based projects:

npm install --save-dev @nitrogql/graphql-loader

For Rollup-based projects:

npm install --save-dev @nitrogql/rollup-plugin

nitrogql's People

Contributors

koichikiyokawa avatar tako8ki avatar tomocrafter avatar uhyo avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.