Authorise GitHub API requests with the appropriate environment variables
$ npm install githubauthreq
Authorise GitHub API requests with the appropriate environment variables
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',
},
})
Using environment variables:
import { getParams } from 'githubauthreq'
fetch(`https://api.github.com/user?${getParams()}`, {
headers: {
Accept: 'application/vnd.github.v3+json',
},
})
getHeaders
, getAuthHeader
, 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
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)))
npm install --save githubauthreq
import pkg from ('githubauthreq')
const pkg = require('githubauthreq').default
<script type="module">
import pkg from '//cdn.skypack.dev/githubauthreq@^5.18.0'
</script>
<script type="module">
import pkg from '//unpkg.com/githubauthreq@^5.18.0'
</script>
<script type="module">
import pkg from '//dev.jspm.io/githubauthreq@5.18.0'
</script>
This package is published with the following editions:
githubauthreq
aliases githubauthreq/index.cjs
which uses the Editions Autoloader to automatically select the correct edition for the consumer's environmentgithubauthreq/source/index.ts
is TypeScript source code with Import for modulesgithubauthreq/edition-browsers/index.js
is TypeScript compiled against ES2019 for web browsers with Import for modulesgithubauthreq/edition-esnext/index.js
is TypeScript compiled against ESNext for Node.js 14 with Require for modulesgithubauthreq/edition-es2019/index.js
is TypeScript compiled against ES2019 for Node.js 10 || 12 || 13 || 14 with Require for modulesgithubauthreq/edition-es2019-esm/index.js
is TypeScript compiled against ES2019 for Node.js 12 || 13 || 14 with Import for modulesDiscover the release history by heading on over to the HISTORY.md
file.
Discover how you can contribute by heading on over to the CONTRIBUTING.md
file.
These amazing people are maintaining this project:
No sponsors yet! Will you be the first?
These amazing people have contributed code to this project:
Discover how you can contribute by heading on over to the CONTRIBUTING.md
file.
Unless stated otherwise all works are:
and licensed under:
© 2010 - cnpmjs.org x YWFE | Home | YWFE