{"id":16410699,"url":"https://github.com/tamino-martinius/node-github-graphql-api","last_synced_at":"2025-03-23T06:31:03.882Z","repository":{"id":66061111,"uuid":"139262120","full_name":"tamino-martinius/node-github-graphql-api","owner":"tamino-martinius","description":"A node client for the GitHub GraphQL API with minimal dependencies created with TypeScript.","archived":false,"fork":false,"pushed_at":"2018-08-07T05:17:07.000Z","size":460,"stargazers_count":8,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-01T22:43:15.150Z","etag":null,"topics":["api","api-client","github","github-api","graphql","jest","node","nodejs","package","typescript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/github-graphql-api","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tamino-martinius.png","metadata":{"files":{"readme":"README.md","changelog":"HISTORY.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-06-30T16:07:50.000Z","updated_at":"2023-12-05T15:26:05.000Z","dependencies_parsed_at":null,"dependency_job_id":"3a9c2db6-a830-4d50-910f-d85ee3fdde68","html_url":"https://github.com/tamino-martinius/node-github-graphql-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tamino-martinius%2Fnode-github-graphql-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tamino-martinius%2Fnode-github-graphql-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tamino-martinius%2Fnode-github-graphql-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tamino-martinius%2Fnode-github-graphql-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tamino-martinius","download_url":"https://codeload.github.com/tamino-martinius/node-github-graphql-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244277179,"owners_count":20427312,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","api-client","github","github-api","graphql","jest","node","nodejs","package","typescript"],"created_at":"2024-10-11T06:43:40.441Z","updated_at":"2025-03-23T06:31:03.386Z","avatar_url":"https://github.com/tamino-martinius.png","language":"TypeScript","readme":"# GitHub GraphQL API\n\n[![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)\n[![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)\n\nA node client for the GitHub GraphQL API with minimal dependencies created with TypeScript.\n\n## Table of contents\n\n\n## Simple Queries\n\nWith 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.\n\n```js\nimport { GitHub } from 'github-graphql-api';\nconst github = new GitHub({ token: 'xxx' })\ngithub.query(`\n  query {\n    rateLimit {\n      remaining\n    }\n  }\n`).then(console.log);\n```\n\n## Passing variables\n\nWith 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.\n\n```js\nimport { GitHub } from 'github-graphql-api';\nconst github = new GitHub({ token: 'xxx' })\n\nconst getUserBio = async (username) =\u003e {\n  return await github.query(`\n    query (\n      $username: String!\n    ) {\n      user(login: $username) {\n        bio\n      }\n    }\n  `, {\n    username,\n  });\n}\n```\n\n## Constructor options\n\n```js\nnew GitHub({\n  token: 'xxx',                  // required\n  apiUrl: 'https://example.com', // default: https://api.github.com/graphql\n})\n```\n\nThe 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.\n\nThe Api URL can be changed for GitHub Enterprise Users which run them on their own domain.\n\n## Require / Import\n\n```js\n// ES6\nimport { GitHub } from 'github-graphql-api';\nimport GithubGraphQLApi from 'github-graphql-api';\n// CommonJs\nconst { Github } = require('github-graphql-api');\nconst GithubGraphQLApi = require('github-graphql-api').default;\n```\n\n## Changelog\n\nSee [history](HISTORY.md) for more details.\n\n* `1.0.0` **2018-07-01** Initial release\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftamino-martinius%2Fnode-github-graphql-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftamino-martinius%2Fnode-github-graphql-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftamino-martinius%2Fnode-github-graphql-api/lists"}