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

1declare namespace PromptSync {
2    export interface Prompt {
3        (opts: Option): string;
4        (ask: string): string;
5        (ask: string, opts: Option): string;
6        (ask: string, value: string): string;
7        /**
8         * prompt -- sync function for reading user input from stdin
9         *  @param {String} ask opening question/statement to prompt for
10         *  @param {String} value initial value for the prompt
11         *  @param {Object} opts {
12         *   echo: set to a character to be echoed, default is '*'. Use '' for no echo
13         *   value: {String} initial value for the prompt
14         *   ask: {String} opening question/statement to prompt for, does not override ask param
15         *   autocomplete: {StringArray} function({String})
16         * }
17         *
18         * @returns {string} Returns the string input or (if sigint === false)
19         *                   null if user terminates with a ^C
20         */
21        (ask: string, value: string, opts: Option): string;
22
23        hide(ask: string): string;
24    }
25
26    export interface Option {
27        ask?: string | undefined;
28        echo?: string | undefined;
29        autocomplete?: AutoCompleteFunction | undefined;
30        value?: string | undefined;
31    }
32
33    export interface Config {
34        sigint?: boolean | undefined;
35        eot?: boolean | undefined;
36        autocomplete?: AutoCompleteFunction | undefined;
37        history?: History | undefined;
38    }
39
40    export interface History {
41        atStart(): boolean;
42        atPenultimate(): boolean;
43        pastEnd(): boolean;
44        atEnd(): boolean;
45        prev(): string;
46        next(): string;
47        reset(): void;
48        push(str: string): void;
49        save(): void;
50    }
51
52    export interface AutoCompleteFunction {
53        (input: string): string[];
54    }
55}
56
57/**
58 * create -- sync function for reading user input from stdin
59 * @param   {Object} config {
60 *   sigint: {Boolean} exit on ^C
61 *   eot: {Boolean} exit on ^D
62 *   autocomplete: {StringArray} function({String})
63 *   history: {String} a history control object (see `prompt-sync-history`)
64 * }
65 * @returns {Function} prompt function
66 */
67declare function PromptSync(config?: PromptSync.Config): PromptSync.Prompt;
68
69export = PromptSync;
70

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:39 GMT
• Dependencies: none

Credits

These definitions were written by TANAKA Koichi, and Yingbo Qiu.