New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
@types/prompt-sync
Advanced tools
@types/prompt-sync - npm Package Compare versions
Comparing version 4.1.1 to 4.2.0
@@ -1,4 +0,4 @@ | ||
| // Type definitions for prompt-sync 4.1.4 | ||
| // Project: https://github.com/0x00A/prompt-sync | ||
| // Definitions by: TANAKA Koichi <https://github.com/MugeSo> | ||
| // 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 | ||
@@ -17,3 +17,3 @@ | ||
| * @param {String} value initial value for the prompt | ||
| * @param {Object} opts { | ||
| * @param {Object} opts { | ||
| * echo: set to a character to be echoed, default is '*'. Use '' for no echo | ||
@@ -42,2 +42,3 @@ * value: {String} initial value for the prompt | ||
| sigint?: boolean | undefined; | ||
| eot?: boolean | undefined; | ||
| autocomplete?: AutoCompleteFunction | undefined; | ||
@@ -68,2 +69,3 @@ history?: History | undefined; | ||
| * sigint: {Boolean} exit on ^C | ||
| * eot: {Boolean} exit on ^D | ||
| * autocomplete: {StringArray} function({String}) | ||
@@ -70,0 +72,0 @@ * history: {String} a history control object (see `prompt-sync-history`) |
| { | ||
| "name": "@types/prompt-sync", | ||
| "version": "4.1.1", | ||
| "version": "4.2.0", | ||
| "description": "TypeScript definitions for prompt-sync", | ||
@@ -12,2 +12,7 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/prompt-sync", | ||
| "githubUsername": "MugeSo" | ||
| }, | ||
| { | ||
| "name": "Yingbo Qiu", | ||
| "url": "https://github.com/qyb", | ||
| "githubUsername": "qyb" | ||
| } | ||
@@ -24,4 +29,4 @@ ], | ||
| "dependencies": {}, | ||
| "typesPublisherContentHash": "8f6703514427027c637853d9088f0f05ba32c4846ce1c168732e40c3de14ad4b", | ||
| "typeScriptVersion": "3.6" | ||
| "typesPublisherContentHash": "6c8f2f44854c1b9790b3e20ad7a502a113d85981126fb885acc5f9ed151aee6c", | ||
| "typeScriptVersion": "4.1" | ||
| } |
@@ -5,86 +5,9 @@ # Installation | ||
| # Summary | ||
| This package contains type definitions for prompt-sync (https://github.com/0x00A/prompt-sync). | ||
| 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 | ||
| // Type definitions for prompt-sync 4.1.4 | ||
| // Project: https://github.com/0x00A/prompt-sync | ||
| // Definitions by: TANAKA Koichi <https://github.com/MugeSo> | ||
| // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped | ||
| 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; | ||
| 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 | ||
| * 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: Thu, 08 Jul 2021 20:19:54 GMT | ||
| * Last updated: Tue, 13 Sep 2022 10:32:46 GMT | ||
| * Dependencies: none | ||
@@ -94,2 +17,2 @@ * Global values: none | ||
| # Credits | ||
| These definitions were written by [TANAKA Koichi](https://github.com/MugeSo). | ||
| These definitions were written by [TANAKA Koichi](https://github.com/MugeSo), and [Yingbo Qiu](https://github.com/qyb). |
No alert changes
Improved metrics
- Lines of code
66
3.13%Worsened metrics
- Total package byte prevSize
5141
-30.49%- Number of lines in readme file
17
-81.91%No dependency changes