JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 419312
  • Score
    100M100P100Q174361F
  • License MIT

Convenience wrapper for `got` to interact with the GitHub API

Package Exports

  • gh-got

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gh-got) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

gh-got Build Status

Convenience wrapper for got to interact with the GitHub API

Install

$ npm install --save gh-got

Usage

Instead of:

const got = require('got');
const token = 'foo';

got('https://api.github.com/users/sindresorhus', {
    json: true,
    headers: {
        'accept': 'application/vnd.github.v3+json',
        'authorization': 'token ' + token
    }
}).then(res => {
    console.log(res.body.login);
    //=> 'sindresorhus'
});

You can do:

const ghGot = require('gh-got');

ghGot('users/sindresorhus', {token: 'foo'}).then(res => {
    console.log(res.body.login);
    //=> 'sindresorhus'
});

API

Same as got (including the stream API and aliases), but with some additional options:

token

Type: string

GitHub access token.

Can be overridden globally with the GITHUB_TOKEN environment variable.

endpoint

Type: string
Default: https://api.github.com/

To support GitHub Enterprise.

Can be overridden globally with the GITHUB_ENDPOINT environment variable.

License

MIT © Sindre Sorhus