@octokit/graphql-schema
TypeScript icon, indicating that this package has built-in type declarations

14.58.0 • Public • Published

graphql-schema

GitHub’s GraphQL Schema with validation. Automatically updated.

Test

Usage

Validation

const { validate } = require("@octokit/graphql-schema");
const errors = validate(`
{
  viewer {
    login
  }
}
`);

// errors is array. Contains errors if any

You can also load the current Schema directly as JSON or IDL.

const { schema } = require("@octokit/graphql-schema");
schema.json; // JSON version
schema.idl; // IDL version

Schema as Types

import { graphql } from "@octokit/graphql";
import { Repository } from "@octokit/graphql-schema";

const { repository } = await graphql<{ repository: Repository }>(
  `
    {
      repository(owner: "octokit", name: "graphql.js") {
        issues(last: 3) {
          edges {
            node {
              title
            }
          }
        }
      }
    }
  `,
  {
    headers: {
      authorization: `token secret123`,
    },
  },
);

Local setup

git clone https://github.com/octokit/graphql-schema.git
cd graphql-schema
npm install
npm test

Update schema files (GITHUB_TOKEN requires no scope)

GITHUB_TOKEN=... npm run update

See also

LICENSE

MIT

Package Sidebar

Install

npm i @octokit/graphql-schema

Weekly Downloads

95,944

Version

14.58.0

License

MIT

Unpacked Size

7.19 MB

Total Files

31

Last publish

Collaborators

  • kfcampbell
  • nickfloyd
  • gr2m
  • octokitbot