typeql

Easier way to provide typings for your graphql queries.

Why use typeql

Below is a sample graphql shema but you don't know what kind of data it returns is it an object, an array of objects, etc.

query HeroNameAndFriends(
  $hero_id: String!
  $some_other_id: Int
  $another_string: String!
) {
  hero_by_id(id: $hero_id, some_id: $some_other_id, another: $another_string) {
    name
    friends {
      name
    }
  }
}

After using typeQL. You get a schema which is more descriptive about the data that you are going to get from this query.

query HeroNameAndFriends(
 $hero_id: String!,
 $some_other_id: Int,
 $another_string: String!
) {
  hero_by_id(id: $hero_id, some_id: $some_other_id, another: $another_string): {
    name: String!
    friends: [{
      name: String!
    }]
  }
}

The above will return the graphql query and typings as such

export interface IResult {
  hero_by_id: {
    name: string;
    friends: {
      name: string | null;
    }[];
  };
}
export interface IVariables {
  hero_id: string;
  some_other_id: number | null;
  another_string: string;
}

query HeroNameAndFriends(
  $hero_id: String!
  $some_other_id: Int
  $another_string: String!
) {
  hero_by_id(id: $hero_id, some_id: $some_other_id, another: $another_string) {
    name
    friends {
      name
    }
  }
}

How to use

• Convert your graphql queries to typeql. Its really simple just take a look inside the tql folder. Note: Remember to seperate your query into multi line or you get wrong output
• Put files inside tql folder with .tql extension
• npm run start
• Get .graphql files in root folder

Known Problems

• Delete typings folder to remove typings/query...ts not under rootDir.
• You have to use multiline queries to get the correct typings/graphql-query from your typeql file.