# @types/yargs-interactive

> TypeScript definitions for yargs-interactive

Latest version **2.1.6** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/yargs-interactive
pnpm add @types/yargs-interactive
yarn add @types/yargs-interactive
bun add @types/yargs-interactive
```

## 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 | 2.1.6 |
| Published | 2023-11-07 |
| First published | 2018-07-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51445 |
| Maintainers | types |

## Links

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

## Dependencies (1)

- [@types/yargs](https://npm.io/package/@types/yargs.md) *

## Recent versions

- 2.1.6 (latest) — 2023-11-07
- 2.1.3 (ts3.8) — 2021-12-24
- 2.1.2 (ts3.6) — 2021-07-02
- 2.1.1 (ts3.0) — 2020-07-12
- 2.1.0 (ts2.0) — 2019-08-02
- 2.1.5 — 2023-10-18
- 2.1.4 — 2023-09-25
- 2.0.0 — 2018-07-14

## README

# Installation
> `npm install --save @types/yargs-interactive`

# Summary
This package contains type definitions for yargs-interactive (https://github.com/nanovazquez/yargs-interactive#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/yargs-interactive.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/yargs-interactive/index.d.ts)
````ts
import { Argv } from "yargs";

declare function yargsInteractive(): yargsInteractive.Interactive;

declare namespace yargsInteractive {
    interface OptionData {
        type: "input" | "number" | "confirm" | "list" | "rawlist" | "expand" | "checkbox" | "password" | "editor";
        describe: string;
        default?: string | number | boolean | any[] | undefined;
        prompt?: "always" | "never" | "if-no-arg" | "if-empty" | undefined;
        choices?: string[] | undefined;
    }
    interface Option {
        [key: string]: OptionData | { default: boolean };
    }
    interface Interactive extends Argv {
        usage(usage: string): Interactive;
        interactive(options: Option): Interactive;
        then(callback: (result: any) => any): Interactive;
    }
}

export = yargsInteractive;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 15:11:36 GMT
 * Dependencies: [@types/yargs](https://npmjs.com/package/@types/yargs)

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

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