Add typings for 'yargs'.

2026-09-11 11:50:54 +08:00 · 2014-10-22 12:20:07 +02:00
parent bd9a1922e4
commit e24d68612a
3 changed files with 274 additions and 0 deletions
@@ -0,0 +1,116 @@
+// Type definitions for yargs
+// Project: https://github.com/chevex/yargs
+// Definitions by: Martin Poelstra <https://github.com/poelstra>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare module "yargs" {
+
+	module yargs {
+		interface Argv {
+			argv: any;
+			(...args: any[]): any;
+			parse(...args: any[]): any;
+
+			alias(shortName: string, longName: string): Argv;
+			alias(aliases: { [shortName: string]: string }): Argv;
+			alias(aliases: { [shortName: string]: string[] }): Argv;
+
+			default(key: string, value: any): Argv;
+			default(defaults: { [key: string]: any}): Argv;
+
+			demand(key: string, msg: string): Argv;
+			demand(key: string, required?: boolean): Argv;
+			demand(keys: string[], msg: string): Argv;
+			demand(keys: string[], required?: boolean): Argv;
+			demand(positionals: number, required?: boolean): Argv;
+			demand(positionals: number, msg: string): Argv;
+
+			require(key: string, msg: string): Argv;
+			require(key: string, required: boolean): Argv;
+			require(keys: number[], msg: string): Argv;
+			require(keys: number[], required: boolean): Argv;
+			require(positionals: number, required: boolean): Argv;
+			require(positionals: number, msg: string): Argv;
+
+			required(key: string, msg: string): Argv;
+			required(key: string, required: boolean): Argv;
+			required(keys: number[], msg: string): Argv;
+			required(keys: number[], required: boolean): Argv;
+			required(positionals: number, required: boolean): Argv;
+			required(positionals: number, msg: string): Argv;
+
+			requiresArg(key: string): Argv;
+			requiresArg(keys: string[]): Argv;
+
+			describe(key: string, description: string): Argv;
+			describe(descriptions: { [key: string]: string }): Argv;
+
+			option(key: string, options: Options): Argv;
+			option(options: { [key: string]: Options }): Argv;
+			options(key: string, options: Options): Argv;
+			options(options: { [key: string]: Options }): Argv;
+
+			usage(message: string, options?: { [key: string]: Options }): Argv;
+			usage(options?: { [key: string]: Options }): Argv;
+
+			example(command: string, description: string): Argv;
+
+			check(func: (argv: { [key: string]: any }, aliases: { [alias: string]: string }) => boolean): Argv;
+			check(func: (argv: { [key: string]: any }, aliases: { [alias: string]: string }) => string): Argv;
+
+			boolean(key: string): Argv;
+			boolean(keys: string[]): Argv;
+
+			string(key: string): Argv;
+			string(keys: string[]): Argv;
+
+			config(key: string): Argv;
+			config(keys: string[]): Argv;
+
+			wrap(columns: number): Argv;
+
+			strict(): Argv;
+
+			help(): string;
+			help(option: string, description?: string): Argv;
+
+			version(version: string, option: string, description?: string): Argv;
+
+			showHelpOnFail(enable: boolean, message?: string): Argv;
+
+			showHelp(func?: (message: string) => any): Argv;
+
+			/* Undocumented */
+
+			normalize(key: string): Argv;
+			normalize(keys: string[]): Argv;
+
+			implies(key: string, value: string): Argv;
+			implies(implies: { [key: string]: string }): Argv;
+
+			count(key: string): Argv;
+			count(keys: string[]): Argv;
+
+			fail(func: (msg: string) => any): void;
+		}
+
+		interface Options {
+			type?: string;
+			alias?: any;
+			demand?: any;
+			required?: any;
+			require?: any;
+			default?: any;
+			boolean?: any;
+			string?: any;
+			count?: any;
+			describe?: any;
+			description?: any;
+			desc?: any;
+			requiresArg?: any;
+		}
+	}
+
+	var yargs: yargs.Argv;
+	export = yargs;
+}