typescript-graphql
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.9 • Public • Published

    typescript-graphql

    Requirements

    You need to have rootDir compiler options set in TypeScript so that the script can generate data in proper places.

    Installation

    1. npm install typescript-graphql

    Make sure you have the peer dependencies installed

    1. npm install graphql GraphQL
    2. npm install typescript --save-dev TypeScript (development dependency)

    How it works

    1. Module with resolvers
    // query.ts
    export const Query = {
      hello() {
        return 'world!';
      },
    };
    1. Snapshot generator

    JavaScript code doesn't provide any information about types at runtime. That's why we need to generate these from the source code using typescript-graphql CLI tool. Use

    npx tsgc query.ts

    This will generate corresponding *.graphql.json files for you that are used at runtime.

    1. Entry point
    // app.ts
    import { buildSchema } from 'typescript-graphql';
    import * as express from 'express';
    import { graphqlHTTP } from 'express-graphql';
    
    const schema = buildSchemaFromCode({
      modulePath: path.resolve(__dirname, './module'),
    });
    
    const app = express();
    app.use(
      '/graphql',
      graphqlHTTP({
        schema: schema,
        graphiql: true,
      })
    );
    app.listen(4000);
    
    console.log('Running a GraphQL API server at http://localhost:4000/graphql');

    Install

    npm i typescript-graphql

    DownloadsWeekly Downloads

    1

    Version

    0.0.9

    License

    MIT

    Unpacked Size

    50.6 kB

    Total Files

    37

    Last publish

    Collaborators

    • mhagmajer