mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-04-01 09:01:45 +08:00
Add "argv.d.ts" (#9392)
This commit is contained in:
15
argv/argv-tests.ts
Normal file
15
argv/argv-tests.ts
Normal file
@@ -0,0 +1,15 @@
|
||||
/// <reference path="argv.d.ts" />
|
||||
import argv = require('argv');
|
||||
argv.version( 'v1.0' );
|
||||
argv.info( 'Special script info' );
|
||||
argv.clear()
|
||||
.option({
|
||||
name: 'option',
|
||||
short: 'o',
|
||||
type: 'string',
|
||||
description: 'Defines an option for your script',
|
||||
example: "'script --opiton=value' or 'script -o value'"
|
||||
})
|
||||
.run([ '--option=123', '-o', '123' ]);
|
||||
argv.run();
|
||||
argv.help();
|
||||
59
argv/argv.d.ts
vendored
Normal file
59
argv/argv.d.ts
vendored
Normal file
@@ -0,0 +1,59 @@
|
||||
// Type definitions for argv
|
||||
// Project: https://www.npmjs.com/package/argv
|
||||
// Definitions by: Hookclaw <https://github.com/hookclaw>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||
declare module "argv" {
|
||||
// argv module
|
||||
type args = {
|
||||
targets:string[],
|
||||
options:{[key:string]:any}
|
||||
};
|
||||
|
||||
type helpOption = {
|
||||
name: string,
|
||||
type: string,
|
||||
short?: string,
|
||||
description?: string,
|
||||
example?: string
|
||||
};
|
||||
|
||||
type module = {
|
||||
mod: string,
|
||||
description: string,
|
||||
options: {[key:string]:helpOption}
|
||||
};
|
||||
|
||||
type typeFunction = (value:any, ...arglist:any[]) => any;
|
||||
|
||||
type argv = {
|
||||
|
||||
// Runs the arguments parser
|
||||
run: ( argv?:string[] ) => args,
|
||||
|
||||
// Adding options to definitions list
|
||||
option: ( mod:helpOption|helpOption[] ) => argv,
|
||||
|
||||
// Creating module
|
||||
mod: ( object:module|module[] ) => argv,
|
||||
|
||||
// Creates custom type function
|
||||
type: ( name:string|{[key:string]:typeFunction}, callback?:typeFunction ) => any,
|
||||
|
||||
// Setting version number, and auto setting version option
|
||||
version: ( v:string ) => argv,
|
||||
|
||||
// Description setup
|
||||
info: ( mod:string, description?:module ) => argv,
|
||||
|
||||
// Cleans out current options
|
||||
clear: () => argv,
|
||||
|
||||
// Prints out the help doc
|
||||
help: ( mod?:string ) => argv
|
||||
|
||||
};
|
||||
|
||||
var argv:argv;
|
||||
|
||||
export = argv;
|
||||
}
|
||||
Reference in New Issue
Block a user