graphql-js README

The project's README from github.com/graphql/graphql-js. As one markdown file: README.md.

GraphQL.js

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

npm version Build 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

With yarn:

yarn add graphql

With bun:

bun 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 source = '{ hello }';

graphql({ schema, source }).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 source = '{ BoyHowdy }';

graphql({ schema, source }).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 17.x.x 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. The exports map within the project package.json should direct runtimes and bundlers to the appropriate files. Tools that do not support exports will find the CommonJS and ESModule builds side by side, with the CommonJS code packaged in files with the .js extension and the ESModule build within .mjs files.

Contributing

We actively welcome pull requests. Learn how to contribute.

This repository is managed by EasyCLA. Project participants must sign the free GraphQL Specification Membership agreement before making a contribution. You only need to do this one time, and it can be signed by individual contributors or their employers.

To initiate the signature process please open a PR against this repo. The EasyCLA bot will block the merge if we still need a membership agreement from you.

You can find detailed information here. If you have issues, please email [email protected].

If your company benefits from GraphQL and you would like to provide essential financial support for the systems and people that power our community, please also consider membership in the GraphQL Foundation.

Changelog

Changes are tracked as GitHub releases.

License

GraphQL.js is MIT-licensed.

Version Support

GraphQL.JS follows Semantic Versioning (SemVer) for its releases. Our version support policy is as follows:

Long-Term Support (LTS)

We do not currently offer a Long-Term Support version of GraphQL.JS. Users are encouraged to upgrade to the latest stable version to receive the most up-to-date features, performance improvements, and security updates.

End-of-Life (EOL) Schedule

We will announce the EOL date for a major version at least 6 months in advance. After a version reaches its EOL, it will no longer receive updates, even for critical security issues.

Upgrade Assistance

To assist users in upgrading to newer versions:

Security Updates

We prioritize the security of GraphQL.JS:

Community Contributions

We welcome community contributions for all versions of GraphQL.JS. However, our maintainers will primarily focus on reviewing and merging contributions for supported versions.

graphql-js (graphql/graphql-js)

Searching Database…

20.3K ·GitHub
Graphql-js
What is this?The JavaScript reference implementation of GraphQL, a query language for APIs created by Facebook — the core library for building and executing GraphQL APIs in JavaScript or TypeScript.
Is it a ready-to-run GraphQL server, or a building block?A building block: GraphQL.js provides two capabilities — building a type schema that maps to your codebase and serving queries against that schema. You wire it into your own Node server or app.
How do I add it to a project and what does basic usage look like?Install the graphql package with npm, yarn or bun, define a schema with types whose fields have resolve functions, then run queries with graphql(). Each query is validated syntactically and semantically before execution, with errors reported otherwise.
If I adopt a version, how long will it keep getting fixes?It follows SemVer: the latest major gets full support; the previous major keeps bug and security fixes plus 12 months of non-breaking feature backports; anything older is unsupported. There is no LTS track, and EOL dates are announced at least 6 months ahead.
Is it Node-only, or can I use it in the browser too?Both — it is a general-purpose library that runs in a Node server and in the browser; the GraphiQL tool is built with it. It ships CommonJS and ESModule builds, so bundlers like webpack or rollup include only the portions you use.
Is it free to use in commercial projects?Yes — GraphQL.js is MIT-licensed, so it is free to use, modify and ship, including commercially.
Can resolver functions load data asynchronously?Yes — a resolve function can return a plain value, a promise, or an array of promises, so fields can be backed by async sources like databases or APIs.
How bumpy are upgrades between major versions?Major releases can include breaking changes, but the project publishes detailed release notes and migration guides for each version, and the community Discord channel #graphql-js is available for upgrade help.
What are similar projects?crystal, ua-parser-js, mongoose, zod, ajv, joi, fastify, protobuf.js
Which topics is it in?esm, schema, validation, parser, graphql, backend, npm, api, nodejs, library, typescript, javascript
Creator
graphql
Size
33.7 MB
Stars
20.3K
Updated
CommitOct 16Releasev17.0.2Jul 03
Age
11y
Commits · 90 Days