@types/prompt-sync - npm Package Compare versions

Comparing version 4.2.1 to 4.2.2

prompt-sync/index.d.ts

@@ -1,6 +0,1 @@
-// Type definitions for prompt-sync 4.2.0
-// Project: https://github.com/heapwolf/prompt-sync
-// Definitions by: TANAKA Koichi <https://github.com/MugeSo>, Yingbo Qiu <https://github.com/qyb>
-// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-
 declare namespace PromptSync {
@@ -7,0 +2,0 @@ export interface Prompt {

prompt-sync/package.json

 {
     "name": "@types/prompt-sync",
-    "version": "4.2.1",
+    "version": "4.2.2",
     "description": "TypeScript definitions for prompt-sync",
@@ -10,9 +10,9 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/prompt-sync",
             "name": "TANAKA Koichi",
-            "url": "https://github.com/MugeSo",
-            "githubUsername": "MugeSo"
+            "githubUsername": "MugeSo",
+            "url": "https://github.com/MugeSo"
         },
         {
             "name": "Yingbo Qiu",
-            "url": "https://github.com/qyb",
-            "githubUsername": "qyb"
+            "githubUsername": "qyb",
+            "url": "https://github.com/qyb"
         }
@@ -29,4 +29,4 @@ ],
     "dependencies": {},
-    "typesPublisherContentHash": "84551a75948ea3b190b578cfba530438fa6c7a1c0a789c6b61116b3733204a21",
+    "typesPublisherContentHash": "e374a43d810e6762a8ee3cfb2217d6bc2146ea7cbae193ad41c91c6d8e5cd410",
     "typeScriptVersion": "4.5"
 }

prompt-sync/README.md

@@ -9,9 +9,81 @@ # Installation
 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: Sun, 24 Sep 2023 06:37:28 GMT
+ * Last updated: Wed, 18 Oct 2023 05:47:09 GMT
  * Dependencies: none
- * Global values: none
 
 # Credits
 These definitions were written by [TANAKA Koichi](https://github.com/MugeSo), and [Yingbo Qiu](https://github.com/qyb).

No alert changes

Improved metrics

Total package byte prevSize

7239

40.84%

Number of lines in readme file

89

423.53%

Worsened metrics

Lines of code

62

-6.06%

No dependency changes