# @types/ghauth

> TypeScript definitions for ghauth

Latest version **3.2.5** (published 2023-11-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/ghauth
pnpm add @types/ghauth
yarn add @types/ghauth
bun add @types/ghauth
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.2.5 |
| Published | 2023-11-21 |
| First published | 2018-12-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51444 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/ghauth
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ghauth
- npm.io page: https://npm.io/package/@types/ghauth

## Recent versions

- 3.2.5 (latest) — 2023-11-21
- 3.2.1 (ts3.6) — 2021-07-08
- 3.2.0 (ts2.0) — 2018-12-07
- 3.2.4 — 2023-11-07
- 3.2.3 — 2023-10-18
- 3.2.2 — 2023-09-20

## README

# Installation
> `npm install --save @types/ghauth`

# Summary
This package contains type definitions for ghauth (https://github.com/rvagg/ghauth).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ghauth.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ghauth/index.d.ts)
````ts
declare function ghauth(
    authOptions: ghauth.AuthOptions,
    callback: (err: Error, tokenData: ghauth.TokenData) => void,
): void;

declare namespace ghauth {
    interface AuthOptions {
        configName: string;

        /**
         * @default false
         */
        noSave?: boolean | undefined;

        /**
         * @default "https://api.github.com/authorizations"
         */
        authUrl?: string | undefined;

        /**
         * @default "GitHub"
         */
        promptName?: string | undefined;

        /**
         * @default []
         */
        scopes?: readonly string[] | undefined;

        /**
         * @default "Node.js command-line app with ghauth"
         */
        note?: string | undefined;

        /**
         * @default "Magic Node.js application that does magic things with ghauth"
         */
        userAgent?: string | undefined;
    }

    interface TokenData {
        user: string;
        token: string;
    }
}

export = ghauth;

````

### Additional Details
 * Last updated: Mon, 20 Nov 2023 23:36:24 GMT
 * Dependencies: none

# Credits
These definitions were written by [Leko](https://github.com/Leko).

---
_Source: https://npm.io/package/@types/ghauth · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._