# github-graphql-api

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

Latest version **1.0.6** (published 2018-08-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install github-graphql-api
pnpm add github-graphql-api
yarn add github-graphql-api
bun add github-graphql-api
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2018-08-07 |
| First published | 2018-06-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=6.14.0 |
| Dependencies | 0 |
| Unpacked size | 15.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Tamino Martinius |
| Maintainers | tamino-martinius |
| Keywords | github, github-api, graphql, api, api-client, typescript, jest, node, nodejs |

## Links

- npm: https://www.npmjs.com/package/github-graphql-api
- Repository: https://github.com/tamino-martinius/node-github-graphql-api
- Homepage: https://github.com/tamino-martinius/node-github-graphql-api#readme
- Issues: https://github.com/tamino-martinius/node-github-graphql-api/issues
- npm.io page: https://npm.io/package/github-graphql-api

## Alternatives

- [apollo-link-http-common](https://npm.io/package/apollo-link-http-common.md) — 879.0K weekly downloads
- [react-relay](https://npm.io/package/react-relay.md) — 336.8K weekly downloads
- [relay-test-utils](https://npm.io/package/relay-test-utils.md) — 181.6K weekly downloads
- [@vendure/core](https://npm.io/package/@vendure/core.md) — 14.8K weekly downloads
- [@pnpm/deps.graph-sequencer](https://npm.io/package/@pnpm/deps.graph-sequencer.md) — 13.4K weekly downloads

## Recent versions

- 1.0.6 (latest) — 2018-08-07
- 1.0.4 — 2018-07-02
- 1.0.3 — 2018-07-01
- 1.0.2 — 2018-07-01
- 1.0.1 — 2018-07-01
- 1.0.0 — 2018-07-01
- 1.0.0-alpha.1 — 2018-06-30

## 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

---
_Source: https://npm.io/package/github-graphql-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._