graphql
    TypeScript icon, indicating that this package has built-in type declarations

    15.6.0 • Public • Published

    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

    A general overview of GraphQL 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 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 graphql@git://github.com/graphql/graphql-js.git#npm
    

    Experimental features

    Each release of GraphQL.js will be accompanied by an experimental release containing support for the @defer and @stream directive proposal. We are hoping to get community feedback on these releases before the proposal is accepted into the GraphQL specification. You can use this experimental release of GraphQL.js by adding the following to your project's package.json file.

    "graphql": "experimental-stream-defer"
    

    Community feedback on this experimental release is much appreciated and can be provided on the issue created for this purpose.

    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.

    Credits

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

    Install

    npm i graphql

    DownloadsWeekly Downloads

    5,160,592

    Version

    15.6.0

    License

    MIT

    Unpacked Size

    2.12 MB

    Total Files

    535

    Last publish

    Collaborators

    • leebyron
    • i1g
    • wincent
    • josephsavona
    • kassens
    • asiandrummer
    • mjmahone