bevry
githubauthreq
Authorize GitHub API requests with the appropriate credentials and preferences.
Usage
Using TypeScript:
// imports using typescript
import { fetch } from 'githubauthreq'
// fetches the GitHub API URL securely via headers authorization, so no redaction is necessary
fetch({
pathname: `user`,
// url, searchParams, headers, credentials = process.env as GitHubCredentials
})Using JavaScript:
// imports with javascript
import { fetch } from 'githubauthreq'
// fetches the GitHub API URL securely via headers authorization, so no redaction is necessary
fetch({
pathname: `user`,
// url, searchParams, headers, credentials = process.env
})If you wish for a more manual approach, refer to the Complete API Documentation..
Install
npm
- Install:
npm install --save githubauthreq - Import:
import * as pkg from ('githubauthreq') - Require:
const pkg = require('githubauthreq')
Skypack
<script type="module">
import * as pkg from '//cdn.skypack.dev/githubauthreq@^8.0.0'
</script>unpkg
<script type="module">
import * as pkg from '//unpkg.com/githubauthreq@^8.0.0'
</script>jspm
<script type="module">
import * as pkg from '//dev.jspm.io/githubauthreq@8.0.0'
</script>Editions
This package is published with the following editions:
githubauthreq/source/index.tsis TypeScript source code with Import for modulesgithubauthreq/edition-browsers/index.jsis TypeScript compiled against ES2020 for web browsers with Import for modulesgithubauthreqaliasesgithubauthreq/edition-es2019/index.jsgithubauthreq/edition-es2019/index.jsis TypeScript compiled against ES2019 for Node.js 10 || 12 || 14 || 16 with Require for modulesgithubauthreq/edition-es2019-esm/index.jsis TypeScript compiled against ES2019 for Node.js 12 || 14 || 16 with Import 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:
Sponsors
No sponsors yet! Will you be the first?
Contributors
These amazing people have contributed code to this project:
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: