Node-Github-GraphQL

A GitHub GraphQL HTTP wrapper

Table of contents

• Node-Github-GraphQL
  • Table of contents
  • Installation
  • Basic Example
  • Advanced Example
  • API Reference
  • LICENSE

Installation

npm install node-github-graphql --save

Basic Example

1var GithubGraphQLApi = require('node-github-graphql')
2var github = new GithubGraphQLApi({
3  token: process.env.GITHUB_API_TOKEN
4})
5github.query(`
6{
7	viewer {
8	  login
9	}
10}
11`, null, (res, err) => {
12  console.log(JSON.stringify(res, null, 2))
13})

Advanced Example

1var GithubGraphQLApi = require('node-github-graphql')
2var github = new GithubGraphQLApi({
3  Promise: require('bluebird'),
4  token: process.env.GITHUB_API_TOKEN,
5  userAgent: 'Hello', // Optional, if not specified, a default user agent will be used
6  debug: true
7})
8github.query(`
9query ($number_of_commits: Int!) {
10  repository(name: "node-github-graphql", owner: "wilsonchingg") {
11    ref(qualifiedName: "master") {
12      target {
13        ...handleCommits
14      }
15    }
16  }
17}
18
19fragment handleCommits on Commit {
20  id
21  history(first: $number_of_commits) {
22    edges {
23      node {
24        author {
25          name
26          date
27        }
28      }
29    }
30  }
31}`, {
32  'number_of_commits': 3
33}
34).then(function (res) {
35  console.log(JSON.stringify(res, null, 2))
36}).catch((err) => { console.log(err) })

API Reference

new GithubGraphQLApi(options)

- options

Type: objects

The accepted keys are as below:

Key	Value
Promise/promise	The promise object
token	Github API key(Mandatory)
debug	To turn on debug log (boolean)
userAgent	User-Agent if specified
url	Alternative url to send the request

github.request(query, variables, callback)

- query

Type: string

GraphQL query

- variables (optional)

Type: object

Dynamic arguments to be passed inside the query string. See http://graphql.org/learn/queries/#variables

- callback (optional)

Type: function (string response, string error)

If callback is specified, it will be used instead of promises.

LICENSE

MIT license. See the LICENSE file for details.