JoshuaKGoldbergOctokit From Auth
Creates a GitHub Octokit instance from any available auth token. π
Usage
npm i octokit-from-auth
Two functions are exported by the octokit-from-auth package.
Both are asynchronous and take in the same constructor parameters as the Octokit class:
octokitFromAuth: rejects if an auth token isn't provided and can't be resolved byget-github-auth-tokenoctokitFromAuthSafe: resolves anOctokitwith no authentication if an auth token isn't provided and can't be resolved byget-github-auth-token
Both return a new Octokit instance.
import { octokitFromAuth } from "octokit-from-auth";
// auth token used:
// process.env.GH_TOKEN ?? (await $`gh auth token`)
await octokitFromAuth();
The Octokit's auth is retrieved with get-github-auth-token, which defaults to process.env.GH_TOKEN, or failing that, gh auth token.
If neither is available then an auth token must be provided as an option:
import { octokitFromAuth } from "octokit-from-auth";
// auth token used:
// "gho_..."
await octokitFromAuth({ auth: "gho_..." });
Development
See .github/CONTRIBUTING.md, then .github/DEVELOPMENT.md.
Thanks! π
Contributors
 Josh Goldberg β¨ π» π π π€ π π§ π π§ |
π This package was templated with
create-typescript-appusing the Bingo framework.