graphql-language-service-types

GraphQL Language Constructs

This feature allows you to define GraphQL schemas using the provided types. The code sample demonstrates how to create a simple schema with a single query field.

import { GraphQLSchema, GraphQLObjectType, GraphQLString } from 'graphql-language-service-types';

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

Diagnostics

This feature provides types for diagnostics, which can be used to report errors and warnings in GraphQL documents. The code sample shows how to create a diagnostic object for a syntax error.

import { Diagnostic, DiagnosticSeverity } from 'graphql-language-service-types';

const diagnostic: Diagnostic = {
  range: {
    start: { line: 0, character: 0 },
    end: { line: 0, character: 5 }
  },
  message: 'Syntax error',
  severity: DiagnosticSeverity.Error
};

Completion Items

This feature provides types for completion items, which can be used to offer code completion suggestions in GraphQL documents. The code sample demonstrates how to create a completion item for a query field.

import { CompletionItem, CompletionItemKind } from 'graphql-language-service-types';

const completionItem: CompletionItem = {
  label: 'Query',
  kind: CompletionItemKind.Field,
  data: 'query'
};