# @types/prompt-sync

> TypeScript definitions for prompt-sync

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

## Install

```sh
npm install @types/prompt-sync
pnpm add @types/prompt-sync
yarn add @types/prompt-sync
bun add @types/prompt-sync
```

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

## Links

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

## Recent versions

- 4.2.3 (latest) — 2023-11-07
- 4.2.0 (ts4.1) — 2022-09-13
- 4.1.1 (ts3.6) — 2021-07-08
- 4.1.0 (ts2.0) — 2016-11-14
- 4.2.2 — 2023-10-18
- 4.2.1 — 2023-09-24

## README

# Installation
> `npm install --save @types/prompt-sync`

# Summary
This package contains type definitions for prompt-sync (https://github.com/heapwolf/prompt-sync).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/prompt-sync.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/prompt-sync/index.d.ts)
````ts
declare namespace PromptSync {
    export interface Prompt {
        (opts: Option): string;
        (ask: string): string;
        (ask: string, opts: Option): string;
        (ask: string, value: string): string;
        /**
         * prompt -- sync function for reading user input from stdin
         *  @param {String} ask opening question/statement to prompt for
         *  @param {String} value initial value for the prompt
         *  @param {Object} opts {
         *   echo: set to a character to be echoed, default is '*'. Use '' for no echo
         *   value: {String} initial value for the prompt
         *   ask: {String} opening question/statement to prompt for, does not override ask param
         *   autocomplete: {StringArray} function({String})
         * }
         *
         * @returns {string} Returns the string input or (if sigint === false)
         *                   null if user terminates with a ^C
         */
        (ask: string, value: string, opts: Option): string;

        hide(ask: string): string;
    }

    export interface Option {
        ask?: string | undefined;
        echo?: string | undefined;
        autocomplete?: AutoCompleteFunction | undefined;
        value?: string | undefined;
    }

    export interface Config {
        sigint?: boolean | undefined;
        eot?: boolean | undefined;
        autocomplete?: AutoCompleteFunction | undefined;
        history?: History | undefined;
    }

    export interface History {
        atStart(): boolean;
        atPenultimate(): boolean;
        pastEnd(): boolean;
        atEnd(): boolean;
        prev(): string;
        next(): string;
        reset(): void;
        push(str: string): void;
        save(): void;
    }

    export interface AutoCompleteFunction {
        (input: string): string[];
    }
}

/**
 * create -- sync function for reading user input from stdin
 * @param   {Object} config {
 *   sigint: {Boolean} exit on ^C
 *   eot: {Boolean} exit on ^D
 *   autocomplete: {StringArray} function({String})
 *   history: {String} a history control object (see `prompt-sync-history`)
 * }
 * @returns {Function} prompt function
 */
declare function PromptSync(config?: PromptSync.Config): PromptSync.Prompt;

export = PromptSync;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: none

# Credits
These definitions were written by [TANAKA Koichi](https://github.com/MugeSo), and [Yingbo Qiu](https://github.com/qyb).

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