githubauthreq

githubauthreq

Authorise GitHub API requests with the appropriate environment variables

Usage

Complete API Documentation.

Fetch

Header

Using environment variables:

import { getHeaders } from 'githubauthreq'
fetch('https://api.github.com/user', {
    headers: getHeaders(),
})

import { getAuthHeader } from 'githubauthreq'
fetch('https://api.github.com/user', {
    headers: {
        Authorization: getAuthHeader(),
        Accept: 'application/vnd.github.v3+json',
    },
})

Query String

Using environment variables:

import { getParams } from 'githubauthreq'
fetch(`https://api.github.com/user?${getParams()}`, {
    headers: {
        Accept: 'application/vnd.github.v3+json',
    },
})

Manual

Both getAuthHeader and getParams accept an object containing either:

• GITHUB_ACCESS_TOKEN
• GITHUB_CLIENT_ID + GITHUB_CLIENT_SECRET

By default they will use process.env if it exists

Redaction

When using query string, you should redact the error message to prevent credentials from leaking in log files:

import { getParams, redactParams } from 'githubauthreq'
fetch(`https://api.github.com/user?${getParams()}`, {
    headers: {
        Accept: 'application/vnd.github.v3+json',
    },
}).catch((err) => console.error(redactParams(err.message)))

Install

npm

• Install: npm install --save githubauthreq
• Import: import * as pkg from ('githubauthreq')
• Require: const pkg = require('githubauthreq')

pika

<script type="module">
    import * as pkg from '//cdn.pika.dev/githubauthreq/^5.1.0'
</script>

unpkg

<script type="module">
    import * as pkg from '//unpkg.com/githubauthreq@^5.1.0'
</script>

jspm

<script type="module">
    import * as pkg from '//dev.jspm.io/githubauthreq@5.1.0'
</script>

Editions

This package is published with the following editions:

• githubauthreq/source/index.ts is TypeScript source code with Import for modules
• githubauthreq/edition-browsers/index.js is TypeScript compiled against ESNext for web browsers with Import for modules
• githubauthreq aliases githubauthreq/edition-es2018/index.js
• githubauthreq/edition-es2018/index.js is TypeScript compiled against ES2018 for Node.js with Require for modules

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

• Benjamin Lupton

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Benjamin Lupton — view contributions
• dependabot-preview[bot] — view contributions

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

• Copyright © 2018+ Benjamin Lupton

and licensed under:

• MIT License

Changelog

v5.1.0 2020 April 27

• Renamed githubQueryString to getParams with b/c alias for githubQueryString, fetch, and default
• Renamed githubAuthorizationHeader to getAuthHeader with b/c alias for githubAuthorizationHeader
• Renamed redact to redactParams with b/c alias for redact
• Added new getHeaders