Skip to content
A reference implementation of GraphQL for JavaScript
JavaScript Shell
Branch: master
Clone or download
Pull request Compare This branch is 1 commit ahead, 13 commits behind graphql:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
docs
resources Add TS typings (graphql#2102) Aug 21, 2019
src Remove unussed 'ABORT_VALIDATION' constant Sep 21, 2019
tstypes
.babelrc.js Switch all 'for..of' loops to assume they iterating only arrays (grap… Aug 20, 2019
.browserslistrc
.eslintrc.yml Update deps (graphql#2166) Sep 15, 2019
.flowconfig Fix bunch of edge cases with empty strings (graphql#2178) Sep 17, 2019
.gitignore
.mocharc.yml Move Mocha config into .mocharc.yml (graphql#1743) Feb 19, 2019
.nycflowrc.yml Run prettier on all files in repo (graphql#2033) Jul 11, 2019
.nycrc.yml
.prettierrc Drop parser option since Prettier supports Flow by default (graphql#1864 May 17, 2019
.travis.yml Drop Support for Node 6 (graphql#2121) Sep 15, 2019
LICENSE Update LICENSE and remove license header from source files (graphql#1960 Jun 10, 2019
README.md Run prettier on all files in repo (graphql#2033) Jul 11, 2019
codecov.yml
package.json Update deps (graphql#2166) Sep 15, 2019
yarn.lock Update deps (graphql#2166) Sep 15, 2019

README.md

GraphQL.js

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 https://graphql.org/ and https://graphql.org/graphql-js/.

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 {
  graphql,
  GraphQLSchema,
  GraphQLObjectType,
  GraphQLString,
} 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" }
  // }
  console.log(result);
});

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 } ] }
  //   ]
  // }
  console.log(result);
});

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://github.com/graphql/graphql-js.git#npm

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!

Contributing

We actively welcome pull requests, learn how to contribute.

Changelog

Changes are tracked as GitHub releases.

License

GraphQL.js is MIT-licensed.

You can’t perform that action at this time.