githubauthreq
Advanced tools
Authorize GitHub API requests with the appropriate credentials and preferences.
Authorize GitHub API requests with the appropriate credentials and preferences.
// imports with typescript
import { GitHubCredentials, getHeaders, getApiUrl, getUrl, redactSearchParams } from 'githubauthreq'
import { env } from 'process
const githubCredentials = env as GitHubCredentials
// if using javascript, omit GitHubCredentials
// recommended: authorization via headers
fetch(getApiUrl(githubCredentials) + '/user', {
headers: getHeaders(githubCredentials),
})
// alternative: authorization via url
try {
// if you want to customize the search params, you can also use: { searchParams: new URLSearchParams() }
fetch(getUrl(githubCredentials, {pathname: '/user'}))
}
catch (err) {
// redact the credentials from the error
console.error(redactSearchParams(err.message))
}
npm install --save githubauthreqimport pkg from ('githubauthreq')const pkg = require('githubauthreq').default<script type="module">
import pkg from '//cdn.skypack.dev/githubauthreq@^6.0.0'
</script>
<script type="module">
import pkg from '//unpkg.com/githubauthreq@^6.0.0'
</script>
<script type="module">
import pkg from '//dev.jspm.io/githubauthreq@6.0.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 || 15 with Require for modulesgithubauthreq/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js 10 || 12 || 14 || 15 with Require for modulesgithubauthreq/edition-es2019-esm/index.js is TypeScript compiled against ES2019 for Node.js 12 || 14 || 15 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:
v6.0.0 2020 November 12
FAQs
Authorize GitHub API requests with the appropriate credentials and preferences.
The npm package githubauthreq receives a total of 5 weekly downloads. As such, githubauthreq popularity was classified as not popular.
We found that githubauthreq demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers uncover how threat actors weaponize Out-of-Band Application Security Testing (OAST) techniques across the npm, PyPI, and RubyGems ecosystems to exfiltrate sensitive data.
Security News
Research
A malicious npm campaign is targeting Ethereum developers by impersonating Hardhat plugins and the Nomic Foundation, stealing sensitive data like private keys.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.