@types/graphql

What is @types/graphql?

@types/graphql provides TypeScript type definitions for the GraphQL JavaScript reference implementation. It allows developers to use GraphQL with TypeScript, ensuring type safety and better development experience.

What are @types/graphql's main functionalities?

Schema Definition

Defines a simple GraphQL schema with a single query field 'hello' that returns a string.

const { GraphQLSchema, GraphQLObjectType, GraphQLString } = require('graphql');

const schema = new GraphQLSchema({
  query: new GraphQLObjectType({
    name: 'RootQueryType',
    fields: {
      hello: {
        type: GraphQLString,
        resolve() {
          return 'Hello world!';
        }
      }
    }
  })
});

Type Definitions

Defines a GraphQL object type for a 'User' with 'id' and 'name' fields.

import { GraphQLObjectType, GraphQLString } from 'graphql';

const UserType = new GraphQLObjectType({
  name: 'User',
  fields: {
    id: { type: GraphQLString },
    name: { type: GraphQLString }
  }
});

Query Execution

Executes a simple GraphQL query against a schema and logs the response.

import { graphql, buildSchema } from 'graphql';

const schema = buildSchema(`
  type Query {
    hello: String
  }
`);

const root = { hello: () => 'Hello world!' };

graphql(schema, '{ hello }', root).then((response) => {
  console.log(response);
});

Other packages similar to @types/graphql

graphql

The official GraphQL JavaScript reference implementation. It provides the core functionality for building GraphQL schemas and executing queries. Unlike @types/graphql, it does not include TypeScript type definitions.

apollo-server

A community-maintained GraphQL server that works with any GraphQL schema. It includes features like caching, subscriptions, and more. It can be used with TypeScript but requires additional type definitions.

type-graphql

A library that allows you to define your GraphQL schema using TypeScript classes and decorators. It provides a more integrated TypeScript experience compared to @types/graphql.

README

Installation

npm install --save @types/graphql

Summary

This package contains type definitions for graphql v0.8.2 (https://www.npmjs.com/package/graphql).

Details

Files were exported from https://www.github.com/DefinitelyTyped/DefinitelyTyped/tree/types-2.0/graphql

Additional Details

• Last updated: Fri, 18 Nov 2016 13:54:01 GMT
• File structure: ModuleAugmentation
• Library Dependencies: none
• Module Dependencies: graphql/error, graphql/error/GraphQLError, graphql/error/formatError, graphql/error/index, graphql/error/locatedError, graphql/error/syntaxError, graphql/execution, graphql/execution/execute, graphql/execution/index, graphql/graphql, graphql/language, graphql/language/ast, graphql/language/index, graphql/language/kinds, graphql/language/lexer, graphql/language/location, graphql/language/parser, graphql/language/printer, graphql/language/source, graphql/language/visitor, graphql/type, graphql/type/definition, graphql/type/directives, graphql/type/index, graphql/type/introspection, graphql/type/scalars, graphql/type/schema, graphql/utilities, graphql/utilities/TypeInfo, graphql/utilities/assertValidName, graphql/utilities/astFromValue, graphql/utilities/buildASTSchema, graphql/utilities/buildClientSchema, graphql/utilities/concatAST, graphql/utilities/extendSchema, graphql/utilities/findBreakingChanges, graphql/utilities/getOperationAST, graphql/utilities/index, graphql/utilities/introspectionQuery, graphql/utilities/isValidJSValue, graphql/utilities/isValidLiteralValue, graphql/utilities/schemaPrinter, graphql/utilities/separateOperations, graphql/utilities/typeComparators, graphql/utilities/typeFromAST, graphql/utilities/valueFromAST, graphql/validation, graphql/validation/index, graphql/validation/specifiedRules, graphql/validation/validate
• Global values: none

Credits

These definitions were written by TonyYang https://github.com/TonyPythoneer, Caleb Meredith https://github.com/calebmer, Dominic Watson https://github.com/intellix.