From daf4d787ea7347674e177665fe7f10fa499e8591 Mon Sep 17 00:00:00 2001 From: Tristan Jones Date: Mon, 2 Jan 2017 22:01:28 -0700 Subject: [PATCH] Fixed capitalization of OptionTypes and extra parens around functions --- readline-sync/index.d.ts | 40 +++++++++++++++++++++------- readline-sync/readline-sync-tests.ts | 1 - 2 files changed, 30 insertions(+), 11 deletions(-) diff --git a/readline-sync/index.d.ts b/readline-sync/index.d.ts index 0307af5eda..78d7e313f9 100644 --- a/readline-sync/index.d.ts +++ b/readline-sync/index.d.ts @@ -3,22 +3,22 @@ // Definitions by: Tristan Jones // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -type optionType = string | number | RegExp | ((input: string) => boolean); +type OptionType = string | number | RegExp | ((input: string) => boolean); interface BasicOptions { prompt?: any; hideEchoBack?: boolean; mask?: string; - limit?: optionType | optionType[]; + limit?: OptionType | OptionType[]; limitMessage?: string; defaultInput?: string; - trueValue?: optionType | optionType[]; - falseValue?: optionType | optionType[]; + trueValue?: OptionType | OptionType[]; + falseValue?: OptionType | OptionType[]; caseSensitive?: boolean; keepWhitespace?: boolean; encoding?: string; bufferSize?: number; - print?: ((display: string, encoding: string) => void); + print?: (display: string, encoding: string) => void; history?: boolean; cd?: boolean; charlist?: string; @@ -29,7 +29,7 @@ interface BasicOptions { exists?: any; isFile?: boolean; isDirectory?: boolean; - validate?: ((path: string) => boolean | string); + validate?: (path: string) => boolean | string; create?: boolean; guide?: boolean; } @@ -47,9 +47,9 @@ export function questionInt(query?: any, options?: BasicOptions): number; export function questionFloat(query?: any, options?: BasicOptions): number; export function questionPath(query?: any, options?: BasicOptions): string; -export function promptCL(commandHandler?: { [id: string]: ((...args: string[]) => void) } | ((command: string, ...args: string[]) => void), options?: BasicOptions): string[]; -export function promptLoop(inputHandler: ((value: string) => boolean), options?: BasicOptions): void; -export function promptCLLoop(commandHandler?: { [id: string]: ((...args: string[]) => boolean | void) } | ((command: string, ...args: string[]) => boolean | void), options?: BasicOptions): void; +export function promptCL(commandHandler?: { [id: string]: (...args: string[]) => void } | ((command: string, ...args: string[]) => void), options?: BasicOptions): string[]; +export function promptLoop(inputHandler: (value: string) => boolean, options?: BasicOptions): void; +export function promptCLLoop(commandHandler?: { [id: string]: (...args: string[]) => boolean | void } | ((command: string, ...args: string[]) => boolean | void), options?: BasicOptions): void; export function promptSimShell(options?: BasicOptions): string; export function keyInYN(query?: any, options?: BasicOptions): boolean | string; @@ -60,8 +60,28 @@ export function keyInSelect(items: string[], query?: any, options?: BasicOptions export function getRawInput(): string; // Deprecated + +/** + * @deprecated Use the bufferSize option instead: readlineSync.setDefaultOptions({bufferSize: value}); + */ export function setBufferSize(value: number): void; + +/** + * @deprecated Use the encoding option instead: readlineSync.setDefaultOptions({encoding: value}); + */ export function setEncoding(value: string): void; + +/** + * @deprecated Use the mask option instead: readlineSync.setDefaultOptions({mask: value}); + */ export function setMask(value: string): void; -export function setPrint(value: ((display: string, encoding: string) => void)): void; + +/** + * @deprecated Use the print option instead: readlineSync.setDefaultOptions({print: value}); + */ +export function setPrint(value: (display: string, encoding: string) => void): void; + +/** + * @deprecated Use the prompt option instead: readlineSync.setDefaultOptions({prompt: value}); + */ export function setPrompt(value: any): void; \ No newline at end of file diff --git a/readline-sync/readline-sync-tests.ts b/readline-sync/readline-sync-tests.ts index a201659e7a..02c8d8e952 100644 --- a/readline-sync/readline-sync-tests.ts +++ b/readline-sync/readline-sync-tests.ts @@ -107,4 +107,3 @@ readlineSync.setEncoding('utf-16'); readlineSync.setMask('%'); readlineSync.setBufferSize(128); -