Wondering what’s next for npm?Check out our public roadmap! »

    githubauthreq
    TypeScript icon, indicating that this package has built-in type declarations

    6.0.0 • Public • Published

    githubauthreq

    Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
    GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

    Authorize GitHub API requests with the appropriate credentials and preferences.

    Usage

    Complete API Documentation.

    // 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))
    }

    Install

    npm

    • Install: npm install --save githubauthreq
    • Import: import pkg from ('githubauthreq')
    • Require: const pkg = require('githubauthreq').default

    Skypack

    <script type="module">
        import pkg from '//cdn.skypack.dev/githubauthreq@^6.0.0'
    </script> 

    unpkg

    <script type="module">
        import pkg from '//unpkg.com/githubauthreq@^6.0.0'
    </script> 

    jspm

    <script type="module">
        import pkg from '//dev.jspm.io/githubauthreq@6.0.0'
    </script> 

    Editions

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

    GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

    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:

    and licensed under:

    Install

    npm i githubauthreq

    DownloadsWeekly Downloads

    2,334

    Version

    6.0.0

    License

    MIT

    Unpacked Size

    62.3 kB

    Total Files

    17

    Last publish

    Collaborators

    • avatar