https://github.com/tamino-martinius/node-github-graphql-api

A node client for the GitHub GraphQL API with minimal dependencies created with TypeScript.
https://github.com/tamino-martinius/node-github-graphql-api

api api-client github github-api graphql jest node nodejs package typescript

Last synced: 3 months ago
JSON representation

A node client for the GitHub GraphQL API with minimal dependencies created with TypeScript.

• Host: GitHub
• URL: https://github.com/tamino-martinius/node-github-graphql-api
• Owner: tamino-martinius
• License: mit
• Created: 2018-06-30T16:07:50.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-08-07T05:17:07.000Z (over 6 years ago)
• Last Synced: 2024-10-12T06:43:44.693Z (3 months ago)
• Topics: api, api-client, github, github-api, graphql, jest, node, nodejs, package, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/github-graphql-api
• Size: 449 KB
• Stars: 8
• Watchers: 2
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHub GraphQL API

[![Build Status](https://travis-ci.org/tamino-martinius/node-github-graphql-api.svg?branch=master)](https://travis-ci.org/tamino-martinius/node-github-graphql-api)

[![codecov](https://codecov.io/gh/tamino-martinius/node-github-graphql-api/branch/master/graph/badge.svg)](https://codecov.io/gh/tamino-martinius/node-github-graphql-api)

A node client for the GitHub GraphQL API with minimal dependencies created with TypeScript.

## Table of contents

## Simple Queries

With this package you can more or less just copy and paste the query and the variables from the [GitHub GraphQL Explorer](https://developer.github.com/v4/explorer/) for immediate results.

```js

import { GitHub } from 'github-graphql-api';

const github = new GitHub({ token: 'xxx' })

github.query(`

  query {

    rateLimit {

      remaining

    }

  }

`).then(console.log);

```

## Passing variables

With this package you can more or less just copy and paste the query and the variables from the [GitHub GraphQL Explorer](https://developer.github.com/v4/explorer/) for immediate results.

```js

import { GitHub } from 'github-graphql-api';

const github = new GitHub({ token: 'xxx' })

const getUserBio = async (username) => {

  return await github.query(`

    query (

      $username: String!

    ) {

      user(login: $username) {

        bio

      }

    }

  `, {

    username,

  });

}

```

## Constructor options

```js

new GitHub({

  token: 'xxx',                  // required

  apiUrl: 'https://example.com', // default: https://api.github.com/graphql

})

```

The GitHub API Token can be created on your [Developer Settings page](https://github.com/settings/tokens). You are able to define the Permissions of the Access Token.

The Api URL can be changed for GitHub Enterprise Users which run them on their own domain.

## Require / Import

```js

// ES6

import { GitHub } from 'github-graphql-api';

import GithubGraphQLApi from 'github-graphql-api';

// CommonJs

const { Github } = require('github-graphql-api');

const GithubGraphQLApi = require('github-graphql-api').default;

```

## Changelog

See [history](HISTORY.md) for more details.

* `1.0.0` **2018-07-01** Initial release