github-schema
GitHub's GraphQL schema
MIT License
Downloads
194
Stars
1
Ecosystems:
TypeScript
📋 github-schema
GitHub's GraphQL Schema
📦 Installation
npm install github-schema
📚 Usage
import { gql, gqlTyped } from "github-schema";
// we are also exporting a ton of types from the graphql schema.
const REPOSITORY_QUERY = gql`
query getRepository($owner: String!, $name: String!) {
repository(owner: $owner, name: $name) {
nameWithOwner
description
pushedAt
url
defaultBranchRef {
name
}
languages(first: 1, orderBy: { field: SIZE, direction: DESC }) {
nodes {
name
color
}
}
}
}
`;
[!NOTE] If you want to use
gqlwith return type ofDocumentNodeyou can do something like this:
import { gqlTyped } from "github-schema";
Editor Autocompletion
[!TIP] You will need to have GraphQL LSP installed, and have a
.graphqlrc.yamlfile in your project root. If you also want nice colors, i would recommend GraphQL Syntax Highlighting installed.
# .graphqlrc.yaml
schema: node_modules/github-schema/schema.graphql
📄 License
Published under MIT License.
Package Rankings
Top 14.36% on Npmjs.org
Badges
Extracted from project README
