# githubauthquerystring
> Authorise GitHub API requests by appending the environments auth credentials to your request's query string.
Latest version **4.0.0** (published 2020-03-26) · MIT license · 0 weekly downloads
> **Deprecated.** This package is deprecated.
## Install
```sh
npm install githubauthquerystring
pnpm add githubauthquerystring
yarn add githubauthquerystring
bun add githubauthquerystring
```
## Health
**Score 10/100 (F)** — status: deprecated.
Negative: deprecated.
## Facts
| | |
|---|---|
| Version | 4.0.0 |
| Published | 2020-03-26 |
| First published | 2018-11-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=8 |
| Dependencies | 1 |
| Unpacked size | 27 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | 2018+ Benjamin Lupton |
| Maintainers | balupton, bevryme |
| Keywords | api, auth, browser, export-default, github, module, querystring, typed, types, typescript |
## Links
- npm: https://www.npmjs.com/package/githubauthquerystring
- Repository: https://github.com/bevry/githubauthquerystring
- Issues: https://github.com/bevry/githubauthquerystring/issues
- Funding: https://bevry.me/fund
- npm.io page: https://npm.io/package/githubauthquerystring
## Dependencies (1)
- [simplytyped](https://npm.io/package/simplytyped.md) ^3.2.3
## Alternatives
- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads
## Recent versions
- 4.0.0 (latest) — 2020-03-26
- 4.0.0-next.1585263623.4ac93fc04f86b47d62732dff79bbc996c8578681 (next) — 2020-03-26
- 4.0.0-next.1585263604.26ff4873284e129ff5fb4cebd0e77fa724a520a6 — 2020-03-26
- 4.0.0-next.1585262913.8d626171c108a63018da090bce64020145f31212 — 2020-03-26
- 3.0.1-next.1576647590.1e0b8a6b75715e201ab828f6ed1026202e312b9c — 2019-12-18
- 3.0.1-next.1576646917.f0a8d44b64a1e6e1a2ab7ff0130e0c08b2503817 — 2019-12-18
- 3.0.1 — 2019-12-18
- 3.0.1-next.1576646437.f7b8c4b0f2683eb1faf0f374b230970d860652fa — 2019-12-18
- 3.0.0 — 2019-12-18
- 3.0.0-next.1576646146.a6f7540f2b8543bab771cabfbaf5aba15e184d86 — 2019-12-18
- 2.3.0 — 2019-12-09
- 2.3.0-next.1575882892.f0cf3d78fa7c1fa21eb33d5a0c2c00edbe0f0bf3 — 2019-12-09
- 2.2.0 — 2019-12-01
- 2.2.0-next.1575176233.e241cce993614efa16e44b29c903e1910a2dbd4c — 2019-12-01
- 2.1.0 — 2019-11-30
- … 14 more at https://npm.io/package/githubauthquerystring/versions
## README
githubauthquerystring
Authorise GitHub API requests by appending the environments auth credentials to your request's query string.
## Usage
[Complete API Documentation.](http://master.githubauthquerystring.bevry.surge.sh/docs/globals.html)
### Fetch
Using environment variables:
```javascript
import githubAuthQueryString from 'githubauthquerystring'
const githubURL = `https://api.github.com/user?${githubAuthQueryString}`
```
Using manual `GITHUB_ACCESS_TOKEN`:
```javascript
import { fetch } from 'githubauthquerystring'
const githubAuthQueryString = fetch({
GITHUB_ACCESS_TOKEN: 'value',
})
const githubURL = `https://api.github.com/user?${githubAuthQueryString}`
```
Using manual `GITHUB_CLIENT_ID` and `GITHUB_CLIENT_SECRET`:
```javascript
import { fetch } from 'githubauthquerystring'
const githubAuthQueryString = fetch({
GITHUB_CLIENT_ID: 'value',
GITHUB_CLIENT_SECRET: 'value',
})
const githubURL = `https://api.github.com/user?${githubAuthQueryString}`
```
If the values did not exist or were not in a valid combination, then an empty string will be returned.
### Redaction
When error reporting, you should redact the error message to prevent credentials from leaking in log files:
```javascript
import { fetch as fetchGithubAuthQueryString, redact } from 'githubauthquerystring'
import 'fetch' from 'cross-fetch'
// fetch the url
const githubAuthQueryString = fetchGithubAuthQueryString({
GITHUB_CLIENT_ID: 'value',
GITHUB_CLIENT_SECRET: 'value'
})
const githubURL = `https://api.github.com/user?${githubAuthQueryString}`
// fetch the response
(async function () {
try {
const resp = await fetch(githubURL)
const data = await resp.json()
}
catch (err) {
// redact the error before logging it
console.error(redact(err.message))
}
})()
```
### Renaming
If you would like to rename the methods to something else, you can do it like so:
```javascript
// using named imports
import ghQueryString, {
fetch as fetchGithubAuthQueryString,
redact as redactGithubAuthQueryString,
} from 'githubauthquerystring'
// using destructuring
const {
default: ghQueryString,
fetch: fetchGithubAuthQueryString,
redact: redactGithubAuthQueryString,
} = require('githubauthquerystring')
```
Install
npm
- Install:
npm install --save githubauthquerystring
- Import:
import pkg from ('githubauthquerystring')
- Require:
const pkg = require('githubauthquerystring').default
pika
``` html
```
unpkg
``` html
```
jspm
``` html
```
This package is published with the following editions:
githubauthquerystring/source/index.ts is TypeScript source code with Import for modulesgithubauthquerystring/edition-browsers/index.js is TypeScript compiled against ESNext for web browsers with Import for modulesgithubauthquerystring aliases githubauthquerystring/edition-es2018/index.jsgithubauthquerystring/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:
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:
---
_Source: https://npm.io/package/githubauthquerystring · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
