graphql

The root graphql entry point exports the graphql() request function and re-exports the public GraphQL.js API from the original submodules. It is the most convenient import path for applications, while the submodule pages in this section document the same exports by area. You can import from the root package or from individual modules such as graphql/execution, graphql/language, and graphql/type; the root package gathers those public exports in one place.

import { graphql, GraphQLSchema, parse, execute } from 'graphql';

Contents

• Request Entry Points
• Version Exports
• Development Mode Exports
• Root Exports by Area
• Export Map
• GraphQLArgs

Request Entry Points

function graphql(args: GraphQLArgs): Promise<ExecutionResult>;
function graphqlSync(args: GraphQLArgs): ExecutionResult;

const result = await graphql({
  schema,
  source: 'query Viewer($id: ID!) { viewer(id: $id) { name } }',
  variableValues: { id: '1' },
  contextValue: { currentUser },
});

Version Exports

Development Mode Exports

Development mode is documented on the root graphql entry point in v17. It is not a separate API section.

import { enableDevMode, isDevModeEnabled } from 'graphql';
 
if (process.env.NODE_ENV === 'development') {
  enableDevMode();
}
 
console.log(isDevModeEnabled());

In v16 and earlier, GraphQL.js development checks were controlled by NODE_ENV. In v17, NODE_ENV is ignored by GraphQL.js itself. Use the development package condition or call enableDevMode() explicitly.

Root Exports by Area

Export Map

GraphQLArgs

interface GraphQLArgs
  extends ParseOptions,
    ValidationOptions,
    Omit<ExecutionArgs, 'document'> {
  source: string | Source;
  rules?: ReadonlyArray<ValidationRule>;
  harness?: GraphQLHarness;
}

GraphQLArgs is deliberately broad in v17:

• Parser options such as noLocation and experimental syntax flags are accepted directly.
• Validation options such as maxErrors and hideSuggestions are accepted directly.
• Execution options such as abortSignal, fieldResolver, typeResolver, and hooks are accepted directly.
• harness can replace the built-in parse, validation, execution, or subscription phases.

import { graphql } from 'graphql';
 
const controller = new AbortController();
 
const result = await graphql({
  schema,
  source,
  variableValues,
  operationName: 'Viewer',
  hideSuggestions: true,
  abortSignal: controller.signal,
});

For incremental delivery, parse and validate separately, then call experimentalExecuteIncrementally(). The convenience graphql() function is a single-result API.