diff --git a/types/yargs-interactive/index.d.ts b/types/yargs-interactive/index.d.ts new file mode 100644 index 0000000000..0f0d3461de --- /dev/null +++ b/types/yargs-interactive/index.d.ts @@ -0,0 +1,26 @@ +// Type definitions for yargs-interactive 2.0 +// Project: https://github.com/nanovazquez/yargs-interactive#readme +// Definitions by: Steven Zeck +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare function yargsInteractive(): yargsInteractive.Interactive; + +declare namespace yargsInteractive { + interface OptionData { + type: string; + describe: string; + default?: string | number | boolean; + prompt?: string; + options?: string[]; + } + interface Option { + [key: string]: OptionData | { default: boolean }; + } + interface Interactive { + usage(usage: string): Interactive; + interactive(options: Option): Interactive; + then(callback: (result: any) => any): Interactive; + } +} + +export = yargsInteractive; diff --git a/types/yargs-interactive/tsconfig.json b/types/yargs-interactive/tsconfig.json new file mode 100644 index 0000000000..5b8ffeee31 --- /dev/null +++ b/types/yargs-interactive/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "yargs-interactive-tests.ts" + ] +} diff --git a/types/yargs-interactive/tslint.json b/types/yargs-interactive/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/yargs-interactive/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } diff --git a/types/yargs-interactive/yargs-interactive-tests.ts b/types/yargs-interactive/yargs-interactive-tests.ts new file mode 100644 index 0000000000..cff1ca16c2 --- /dev/null +++ b/types/yargs-interactive/yargs-interactive-tests.ts @@ -0,0 +1,19 @@ +/// + +import yargsInteractive = require("yargs-interactive"); + +const options: yargsInteractive.Option = { + color: { + describe: "What is your favorite color?", + prompt: "always", + type: "input", + default: "Blue", + } +}; + +yargsInteractive() + .usage("$0 [args]") + .interactive(options) + .then((result: any) => { + console.log(result); + });