Add type definitions for https://www.npmjs.com/package/cli

2026-04-24 05:06:02 +08:00 · 2016-03-19 15:18:38 +01:00
parent c4309e0e64
commit 7c1a4fd51f
2 changed files with 247 additions and 0 deletions
--- a/cli/cli.d.ts
+++ b/cli/cli.d.ts
@@ -0,0 +1,66 @@
+// Type definitions for cli v0.11.2
+// Project: https://www.npmjs.com/package/cli
+// Definitions by: Klaus Reimer <https://github.com/kayahr>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+/// <reference path="../node/node.d.ts" />
+
+declare module "cli" {
+    interface CLI {
+        app: string;
+        version: string;
+        argv: string[];
+        argc: number;
+        options: any;
+        args: string[];
+        command: string;
+        width: number;
+        option_width: number;
+        native: any;
+        output(message?: any, ...optionalParams: any[]): void;
+        exit(code: number): void;
+        no_color: boolean;
+        enable(...plugins: string[]): CLI;
+        disable(...plugins: string[]): CLI;
+        setArgv(argv: string | Array<any>, keepArg0?: boolean): void;
+        next(): string;
+        parse(opts?: { [long: string]: { 0: string | boolean, 1: string, 2?: string, 3?: any } },
+              commands?: { [name: string]: string } | string[]): any;
+        autocompleteCommand(command: string): string;
+        info(msg: string): void;
+        error(msg: string): void;
+        ok(msg: string): void;
+        debug(msg: string): void;
+        fatal(msg: string): void;
+        setApp(appName: string, version: string): CLI;
+        setApp(packageJson: string): CLI;
+        parsePackageJson(path?: string): void;
+        setUsage(usage: string): CLI;
+        getUsage(code?: number): void;
+        getOptError(expects: string, type: string): string;
+        getValue(defaultVal: string, validateFunc: (value: any) => any, errMsg: string): void;
+        getInt(defaultVal: number): number;
+        getDate(defaultVal: Date): Date;
+        getFloat(defaultVal: number): number;
+        getUrl(defautltVal: string, identifier?: string): string;
+        getEmail(defaultVal: string): string;
+        getIp(defaultVal: string): string;
+        getPath(defaultVal: string, identifier?: string): string;
+        getArrayValue<T>(arr: T[], defaultVal: T): T;
+        withStdin(callback: (data: string) => void): void;
+        withStdin(encoding: string, callback: (text: string) => void): void;
+        withStdinLines(callback: (lines: string[], newline: string) => void): void;
+        withInput(file: string, encoding: string, callback: (line: string, newline: string, eof: boolean) => void): void;
+        withInput(file: string, callback: (line: string, newline: string, eof: boolean) => void): void;
+        withInput(callback: (line: string, newline: string, eof: boolean) => void): void;
+        toType(object: any): string;
+        daemon(arg: string, callback: () => void): void;
+        main(callback: (args: string[], options: any) => void): void;
+        createServer(...args: any[]): any;
+        exec(cmd: string, callback?: (lines: string[]) => void, errback?: (err: any, stdout: string) => void): void;
+        progress(progress: number, decimals?: number, stream?: NodeJS.WritableStream): void;
+        spinner(prefix?: string | boolean, end?: boolean, stream?: NodeJS.WritableStream): void;
+    }
+    const cli: CLI;
+    export = cli;
+}