graphql

GraphQL.js provides a reference implementation for the GraphQL specification but is also a useful utility for operating on GraphQL files and building sophisticated tools.

This primary module exports a general purpose function for fulfilling all steps of the GraphQL specification in a single operation, but also includes utilities for every part of the GraphQL specification:

• Parsing the GraphQL language.
• Building a GraphQL type schema.
• Validating a GraphQL request against a type schema.
• Executing a GraphQL request against a type schema.

This also includes utility functions for operating on GraphQL types and GraphQL documents to facilitate building tools.

Most exports are also available from package submodules. For example, these two references resolve to the same parse function:

import { parse } from 'graphql';
import { parse } from 'graphql/language';

Functions

graphql()

Parses, validates, and executes a GraphQL document against a schema.

This is the primary entry point for fulfilling GraphQL operations. Use this when you want a single-call request lifecycle that returns a promise in all cases.

More sophisticated GraphQL servers, such as those which persist queries, may wish to separate the validation and execution phases to a static-time tooling step and a server runtime step.

Signature:

graphql(args: GraphQLArgs): Promise<ExecutionResult>

Arguments

Returns

Example

import { graphql, buildSchema } from 'graphql';
 
const schema = buildSchema('type Query { hello: String }');
 
const result = await graphql({
  schema,
  source: '{ hello }',
  rootValue: { hello: 'world' },
});
 
// result: { data: { hello: 'world' } }

graphqlSync()

Parses, validates, and executes a GraphQL document synchronously.

This function guarantees that execution completes synchronously, or throws an error, assuming that all field resolvers are also synchronous. It throws when any resolver returns a promise.

Signature:

graphqlSync(args: GraphQLArgs): ExecutionResult

Arguments

Returns

Example

import { graphqlSync, buildSchema } from 'graphql';
 
const schema = buildSchema('type Query { hello: String }');
 
const result = graphqlSync({
  schema,
  source: '{ hello }',
  rootValue: { hello: 'world' },
});
 
// result: { data: { hello: 'world' } }

Constants

version

A string containing the version of the GraphQL.js library

versionInfo

An object containing the components of the GraphQL.js version string

Types

GraphQLArgs

Interface. Describes the input object accepted by graphql and graphqlSync.

These arguments describe the full parse, validate, and execute lifecycle for a GraphQL request.

Members