deno.land / x / yargs@v17.6.0-deno / build / lib / typings / yargs-parser-types.d.ts

yargs-parser-types.d.ts
نووسراو ببینە
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
import type { Dictionary, ValueOf, nil } from './common-types.js';declare type KeyOf<T> = { [K in keyof T]: string extends K ? never : number extends K ? never : K;} extends { [_ in keyof T]: infer U;} ? U : never;export declare type ArgsInput = string | any[];export declare type ArgsOutput = (string | number)[];export interface Arguments { _: ArgsOutput; '--'?: ArgsOutput; [argName: string]: any;}export interface DetailedArguments { argv: Arguments; error: Error | null; aliases: Dictionary<string[]>; newAliases: Dictionary<boolean>; defaulted: Dictionary<boolean>; configuration: Configuration;}export interface Configuration { 'boolean-negation': boolean; 'camel-case-expansion': boolean; 'combine-arrays': boolean; 'dot-notation': boolean; 'duplicate-arguments-array': boolean; 'flatten-duplicate-arrays': boolean; 'greedy-arrays': boolean; 'halt-at-non-option': boolean; 'nargs-eats-options': boolean; 'negation-prefix': string; 'parse-positional-numbers': boolean; 'parse-numbers': boolean; 'populate--': boolean; 'set-placeholder-key': boolean; 'short-option-groups': boolean; 'strip-aliased': boolean; 'strip-dashed': boolean; 'unknown-options-as-args': boolean;}export declare type ArrayOption = string | { key: string; boolean?: boolean; string?: boolean; number?: boolean; integer?: boolean;};export declare type CoerceCallback = (arg: any) => any;export declare type ConfigCallback = (configPath: string) => { [key: string]: any;} | Error;export interface Options { alias: Dictionary<string | string[]>; array: ArrayOption | ArrayOption[]; boolean: string | string[]; config: string | string[] | Dictionary<boolean | ConfigCallback>; configObjects: Dictionary<any>[]; configuration: Partial<Configuration>; coerce: Dictionary<CoerceCallback>; count: string | string[]; default: Dictionary<any>; envPrefix?: string; narg: Dictionary<number>; normalize: string | string[]; string: string | string[]; number: string | string[]; __: (format: any, ...param: any[]) => string; key: Dictionary<any>;}export interface PlatformShim { cwd: Function; format: Function; normalize: Function; require: Function; resolve: Function; env: Function;}export declare type OptionsDefault = ValueOf<Pick<Required<Options>, 'default'>>;export interface Parser { (args: ArgsInput, opts?: Partial<Options>): Arguments; detailed(args: ArgsInput, opts?: Partial<Options>): DetailedArguments; camelCase(str: string): string; decamelize(str: string, joinString?: string): string; looksLikeNumber(x: nil | number | string): boolean;}export declare type StringFlag = Dictionary<string[]>;export declare type BooleanFlag = Dictionary<boolean>;export declare type NumberFlag = Dictionary<number>;export declare type ConfigsFlag = Dictionary<string | string[] | boolean | ConfigCallback>;export declare type CoercionsFlag = Dictionary<CoerceCallback>;export declare type KeysFlag = string[];export interface Flags { aliases: StringFlag; arrays: BooleanFlag; bools: BooleanFlag; strings: BooleanFlag; numbers: BooleanFlag; counts: BooleanFlag; normalize: BooleanFlag; configs: ConfigsFlag; nargs: NumberFlag; coercions: CoercionsFlag; keys: KeysFlag;}export declare type Flag = ValueOf<Omit<Flags, 'keys'>>;export declare type FlagValue = ValueOf<Flag>;export declare type FlagsKey = KeyOf<Omit<Flags, 'keys'>>;export declare type ArrayFlagsKey = Extract<FlagsKey, 'bools' | 'strings' | 'numbers'>;export interface DefaultValuesForType { boolean: boolean; string: string; number: undefined; array: any[];}export declare type DefaultValuesForTypeKey = KeyOf<DefaultValuesForType>;export {};
yargs

Version Info

Tagged at
2 years ago