Skip to content
A reference implementation of GraphQL for JavaScript
JavaScript Shell
Branch: master
Clone or download

Latest commit

Latest commit 157edcb Mar 20, 2020


Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Remove outdated "Live Feedback" section from CONTRIBUTING.modif… (#2280) Dec 7, 2019
docs docs: correctly tag code samples (#2256) Nov 14, 2019
resources Benchmark: set 'NODE_ENV=production' before running the benchmarks (#… Feb 6, 2020
src TS: remove TS-specific TSource argument for resolveFieldValueOr… (#2491) Mar 20, 2020
.babelrc.json Babel: switch to using .babelrc.json as config (#2396) Jan 26, 2020
.browserslistrc Drop Support for Node 6 (#2121) Sep 15, 2019
.eslintrc.yml Update deps (#2476) Mar 6, 2020
.flowconfig Update deps (#2476) Mar 6, 2020
.gitignore Adapt benchmark to the new build script (#1845) May 2, 2019
.mocharc.yml Drop 'babel-polyfill' (#2398) Jan 26, 2020
.nycflowrc.yml Run prettier on all files in repo (#2033) Jul 11, 2019
.nycrc.yml nyc: exclude export files added only for deprecation (#2425) Feb 4, 2020
.prettierrc Drop parser option since Prettier supports Flow by default (#1864) May 17, 2019
.travis.yml Add node v13 to CI (#2291) Dec 16, 2019
LICENSE Update LICENSE and remove license header from source files (#1960) Jun 10, 2019 docs: Add note about 'NODE_ENV=production' (#2435) Feb 6, 2020
codecov.yml Make codecov less spammy (#1694) Jan 27, 2019
cspell.json GraphQLError: convert to ES6 class (#2369) Jan 20, 2020
package.json Update deps (#2476) Mar 6, 2020
yarn.lock Update deps (#2476) Mar 6, 2020


The JavaScript reference implementation for GraphQL, a query language for APIs created by Facebook.

npm version Build Status Coverage Status

See more complete documentation at and

Looking for help? Find resources from the community.

Getting Started

An overview of GraphQL in general is available in the README for the Specification for GraphQL. That overview describes a simple set of GraphQL examples that exist as tests in this repository. A good way to get started with this repository is to walk through that README and the corresponding tests in parallel.

Using GraphQL.js

Install GraphQL.js from npm

With yarn:

yarn add graphql

or alternatively using npm:

npm install --save graphql

GraphQL.js provides two important capabilities: building a type schema, and serving queries against that type schema.

First, build a GraphQL type schema which maps to your code base.

import {
} from 'graphql';

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

This defines a simple schema with one type and one field, that resolves to a fixed value. The resolve function can return a value, a promise, or an array of promises. A more complex example is included in the top level tests directory.

Then, serve the result of a query against that type schema.

var query = '{ hello }';

graphql(schema, query).then(result => {
  // Prints
  // {
  //   data: { hello: "world" }
  // }

This runs a query fetching the one field defined. The graphql function will first ensure the query is syntactically and semantically valid before executing it, reporting errors otherwise.

var query = '{ BoyHowdy }';

graphql(schema, query).then(result => {
  // Prints
  // {
  //   errors: [
  //     { message: 'Cannot query field BoyHowdy on RootQueryType',
  //       locations: [ { line: 1, column: 3 } ] }
  //   ]
  // }

Note: Please don't forget to set NODE_ENV=production if you are running a production server it will disable some checks that can be useful during development but will significantly improve performance.

Want to ride the bleeding edge?

The npm branch in this repository is automatically maintained to be the last commit to master to pass all tests, in the same form found on npm. It is recommended to use builds deployed to npm for many reasons, but if you want to use the latest not-yet-released version of graphql-js, you can do so by depending directly on this branch:

npm install graphql@git://

Using in a Browser

GraphQL.js is a general purpose library and can be used both in a Node server and in the browser. As an example, the GraphiQL tool is built with GraphQL.js!

Building a project using GraphQL.js with webpack or rollup should just work and only include the portions of the library you use. This works because GraphQL.js is distributed with both CommonJS (require()) and ESModule (import) files. Ensure that any custom build configurations look for .mjs files!


We actively welcome pull requests, learn how to contribute.


Changes are tracked as GitHub releases.


GraphQL.js is MIT-licensed.


The *.d.ts files in this project are based on DefinitelyTyped definitions written by:

You can’t perform that action at this time.