githubauthreq

githubauthreq

Authorize GitHub API requests with the appropriate credentials and preferences.

Usage

Complete API Documentation.

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.ts is TypeScript source code with Import for modules
• githubauthreq/edition-browsers/index.js is TypeScript compiled against ES2020 for web browsers with Import for modules
• githubauthreq aliases githubauthreq/edition-es2019/index.js
• githubauthreq/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js 10 || 12 || 14 || 16 with Require for modules
• githubauthreq/edition-es2019-esm/index.js is 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:

• Benjamin Lupton — view contributions

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Benjamin Lupton — 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

v8.0.0 2021 August 4

• getURL, getCredentialedURL, and fetch now accept a single argument, which is the same as before but now supports url and credentials properties, and if credentials is nullish then it attempts to use the environment variables