Type aliases
Action
Action
<O>: (option
: O, context
: Context) => string[] | Promise<string[]>Type parameters
Type declaration
- (option: O, context: Context): string[] | Promise<string[]>
Parameters
Returns string[] | Promise<string[]>
DefaultArgument
DefaultArgument: { --?: string[]; _: string[] }
Type declaration
Optional --?: string[]
_: string[]
ExecutionData
ExecutionData<O>: { commands: string[]; option?: O }
Type parameters
Type declaration
commands: string[]
Optional option?: O
HistoryData
HistoryData<I, O>: { input: I | undefined; output: O | undefined }
Type parameters
Type declaration
input: I | undefined
output: O | undefined
Nullable
Nullable<T>: Optional<T>
Type parameters
OptionData
OptionData: { args: string[]; debug: boolean; dryrun: boolean; extraArgs: string[]; help: boolean; raw: string[] }
Type declaration
args: string[]
debug: boolean
dryrun: boolean
extraArgs: string[]
help: boolean
raw: string[]
OptionMapper
Type parameters
OptionTransformer
OptionTransformer<T>: { alias?: string[]; defaultValue: T; fn?: any }
Type parameters
Type declaration
Optional alias?: string[]
defaultValue: T
fn?:function
- fn(value: string, def: T): T
Transformer
Transformer
<I, O, P>: { name
: string; previous
?: Transformer<P, I>; transform
: any }Type parameters
Type declaration
name: string
Optional previous?: Transformer<P, I>
transform:function
- transform(input: I, context: Context): O
If opts['--'] is true, populated with everything after the --