gql-typescript-generator

npmpackage.info

Gathering detailed insights and metrics for gql-typescript-generator

Other packages similar to gql-typescript-generator

@graphql-codegen/core

4.0.2

@graphql-codegen/cli

5.0.7

gql-test-generator

1.0.14

Forked from graphql-codegen-typescript-validation-schema. Getting something together to generate smoke tests automatically across resolvers.

graphql-codegen-typescript-validation-schema

0.17.1

GraphQL Code Generator plugin to generate form validation schema from your GraphQL schema

Gathering detailed insights and metrics for gql-typescript-generator

Usage

1# Install 2npm install gql-generator -g 3 4# see the usage 5gqlg --help 6 7# Generate sample queries from schema file 8gqlg --schemaFilePath ./example/sampleTypeDef.graphql --destDirPath ./example/output --depthLimit 5

Now the queries generated from the sampleTypeDef.graphql can be found in the destDir: ./example/output.

This tool generate 3 folders holding the queries: mutations, queries and subscriptions. And also index.js files to export the queries in each folder.

You can require the queries like this:

1// require all the queries 2const queries = require('./example/output'); 3// require mutations only 4const mutations = require('./example/output/mutations'); 5 6// sample content 7console.log(queries.mutations.signup); 8console.log(mutations.signup); 9/* 10mutation signup($username: String!, email: String!, password: String!){ 11 signup(username: $username, email: $email, password: $password){ 12 token 13 user { 14 id 15 username 16 email 17 createdAt 18 } 19 } 20} 21*/ 22

Usage example

Say you have a graphql schema like this:

1type Mutation { 2 signup( 3 email: String! 4 username: String! 5 password: String! 6 ): UserToken! 7} 8 9type UserToken { 10 token: String! 11 user: User! 12} 13 14type User { 15 id: Int! 16 username: String! 17 email: String! 18 createdAt: String! 19}

Before this tool, you write graphql api test like this:

1const { GraphQLClient } = require('graphql-request'); 2require('should'); 3 4const host = 'http://localhost:8080/graphql'; 5 6test('signup', async () => { 7 const gql = new GraphQLClient(host); 8 const query = `mutation signup($username: String!, email: String!, password: String!){ 9 signup(username: $username, email: $email, password: $password){ 10 token 11 user { 12 id 13 username 14 email 15 createdAt 16 } 17 } 18 }`; 19 20 const data = await gql.request(query, { 21 username: 'tim', 22 email: 'timqian92@qq.com', 23 password: 'samplepass', 24 }); 25 26 (typeof data.signup.token).should.equal('string'); 27);

As gqlg generated the queries for you, you don't need to write the query yourself, so your test will becomes:

1const { GraphQLClient } = require('graphql-request'); 2require('should'); 3const mutations = require('./example/output/mutations'); 4 5const host = 'http://localhost:8080/graphql'; 6 7test('signup', async () => { 8 const gql = new GraphQLClient(host); 9 10 const data = await gql.request(mutations.signup, { 11 username: 'tim', 12 email: 'timqian92@qq.com', 13 password: 'samplepass', 14 }); 15 16 (typeof data.signup.token).should.equal('string'); 17);

Other packages similar to gql-typescript-generator

Other packages similar to gql-typescript-generator

Installations

Developer Guide

No

CommonJS

12.16.2

6.14.4

Pull Requests

2

6

0

4

Issues

0

0

0

Releases

Unable to fetch releases

Languages

Developer

TheBrainFamily

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

gql-generator

Example

Usage

Usage example

Notice

10

10

1

0

0

0

0

0

0

0

1.9

/10