Github url

graphql-js

by graphql

graphql /graphql-js

A reference implementation of GraphQL for JavaScript

16.3K Stars 1.6K Forks Last release: 1 day ago (v14.7.0) MIT License 2.6K Commits 115 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

GraphQL.js

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

npm versionBuild StatusCoverage 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

A general overview of GraphQL is available in theREADME for theSpecification for GraphQL. That overview describes a simple set of GraphQL examples that exist as testsin 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 npm:

npm install --save graphql

or using yarn:

yarn add 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 codebase.

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); });

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 [email protected]://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 GraphiQLtool is built with GraphQL.js!

Building a project using GraphQL.js with webpack orrollup 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.

Credits

The

\*.d.ts

files in this project are based on DefinitelyTyped definitions written by:

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.