@types/args

TypeScript definitions for args

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@types/args
40,9038355.0.0a year ago5 years agoMinified + gzip package size for @types/args in KB

Readme

Installation
npm install --save @types/args
Summary
This package contains type definitions for args (https://github.com/leo/args#readme).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/args.

index.d.ts

````ts // Type definitions for args 5.0 // Project: https://github.com/leo/args#readme // Definitions by: Slessi // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
declare const c: args; export = c;
interface args {
sub: string[];

option(name: string | [string, string], description: string, defaultValue?: any, init?: OptionInitFunction): args;
options(list: Option[]): args;
command(name: string, description: string, init?: (name: string, sub: string[], options: ConfigurationOptions) => void, aliases?: string[]): args;
example(usage: string, description: string): args;
examples(list: Example[]): args;
parse(argv: string[], options?: ConfigurationOptions): { [key: string]: any };
showHelp(): void;
showVersion(): void;
}
type OptionInitFunction = (value: any) => any;
interface MriOptions {
args?: string[] | undefined;
alias?: {
    [key: string]: string | string[]
} | undefined;
boolean?: string | string[] | undefined;
default?: {
    [key: string]: any
} | undefined;
string?: string | string[] | undefined;
unknown?: ((param: string) => boolean) | undefined;
}
interface MinimistOptions {
string?: string | string[] | undefined;
boolean?: boolean | string | string[] | undefined;
alias?: {
    [key: string]: string | string[]
} | undefined;
default?: {
    [key: string]: any
} | undefined;
stopEarly?: boolean | undefined;
"--"?: boolean | undefined;
unknown?: ((param: string) => boolean) | undefined;
}
interface ConfigurationOptions {
help?: boolean | undefined;
name?: string | undefined;
version?: boolean | undefined;
usageFilter?: ((output: any) => any) | undefined;
value?: string | undefined;
mri: MriOptions;
minimist?: MinimistOptions | undefined;
mainColor: string | string[];
subColor: string | string[];
}
interface Option {
name: string | [string, string];
description: string;
init?: OptionInitFunction | undefined;
defaultValue?: any;
}
interface Example {
usage: string;
description: string;
} ````

Additional Details

Last updated: Fri, 24 Sep 2021 21:31:22 GMT Dependencies: none Global values: none
Credits
These definitions were written by Slessi
.