import { YargsInstance } from "https://deno.land/x/yargs@v17.7.2-deno/build/lib/yargs-factory.d.ts";
Constructors
new
YargsInstance(processArgs: string | string[] | undefined,
cwd: string,
parentRequire: RequireType | undefined,
shim: PlatformShim,
Methods
addHelpOpt(opt?: string | false, msg?: string): YargsInstance
addShowHiddenOpt(opt?: string | false, msg?: string): YargsInstance
alias(key: string | string[] | Dictionary<string | string[]>, value?: string | string[]): YargsInstance
array(keys: string | string[]): YargsInstance
boolean(keys: string | string[]): YargsInstance
check(f: (argv: Arguments, options: Options) => any, global?: boolean): YargsInstance
choices(key: string | string[] | Dictionary<string | string[]>, value?: string | string[]): YargsInstance
coerce(keys: string | string[] | Dictionary<CoerceCallback>, value?: CoerceCallback): YargsInstance
command(): YargsInstance
cmd: string | CommandHandlerDefinition | DefinitionOrCommandName[],
description?: CommandHandler["description"],
builder?: CommandBuilderDefinition | CommandBuilder,
handler?: CommandHandlerCallback,
middlewares?: Middleware[],
deprecated?: boolean,
commandDir(dir: string, opts?: RequireDirectoryOptions): YargsInstance
commands(): YargsInstance
cmd: string | CommandHandlerDefinition | DefinitionOrCommandName[],
description?: CommandHandler["description"],
builder?: CommandBuilderDefinition | CommandBuilder,
handler?: CommandHandlerCallback,
middlewares?: Middleware[],
deprecated?: boolean,
conflicts(key1: string | Dictionary<string | string[]>, key2?: string | string[]): YargsInstance
count(keys: string | string[]): YargsInstance
demand(): YargsInstance
keys: ,
max?: ,
| number
| string[]
| string
| true
msg?: string | true,
demandCommand(): YargsInstance
min?: number,
max?: number | string,
minMsg?: string | null,
maxMsg?: string | null,
demandOption(keys: string | string[] | Dictionary<string | undefined>, msg?: string): YargsInstance
deprecateOption(option: string, message: string | boolean): YargsInstance
describe(keys: string | string[] | Dictionary<string>, description?: string): YargsInstance
detectLocale(detect: boolean): YargsInstance
env(prefix?: string | false): YargsInstance
epilog(msg: string): YargsInstance
epilogue(msg: string): YargsInstance
example(cmd: string | [string, string][], description?: string): YargsInstance
exitProcess(enabled?: boolean): YargsInstance
fail(f: FailureFunction | boolean): YargsInstance
getAliases(): Dictionary<string[]>
getCompletion(args: string[], done?: (err: Error | null, completions: string[] | undefined) => void): Promise<string[] | void>
getDemandedCommands(): Dictionary<{ min: number; max: number; minMsg?: string | null | undefined; maxMsg?: string | null | undefined; }>
getDemandedOptions(): Dictionary<string | undefined>
getDeprecatedOptions(): Dictionary<string | boolean | undefined>
getDetectLocale(): boolean
getExitProcess(): boolean
getGroups(): Dictionary<string[]>
getHelp(): Promise<string>
getStrict(): boolean
getStrictCommands(): boolean
getStrictOptions(): boolean
global(globals: string | string[], global?: boolean): YargsInstance
group(opts: string | string[], groupName: string): YargsInstance
help(opt?: string, msg?: string): YargsInstance
hide(key: string): YargsInstance
implies(key: string | Dictionary<KeyOrPos | KeyOrPos[]>, value?: KeyOrPos | KeyOrPos[]): YargsInstance
locale(locale?: string): YargsInstance | string
middleware(): YargsInstance
callback: MiddlewareCallback | MiddlewareCallback[],
applyBeforeValidation?: boolean,
global?: boolean,
nargs(key: string | string[] | Dictionary<number>, value?: number): YargsInstance
normalize(keys: string | string[]): YargsInstance
number(keys: string | string[]): YargsInstance
option(key: string | Dictionary<OptionDefinition>, opt?: OptionDefinition): YargsInstance
options(key: string | Dictionary<OptionDefinition>, opt?: OptionDefinition): YargsInstance
parseAsync(): Promise<Arguments>
args?: string | string[],
shortCircuit?: object | ParseCallback | boolean,
_parseFn?: ParseCallback,
parserConfiguration(config: Configuration): this
pkgConf(key: string, rootPath?: string): YargsInstance
positional(key: string, opts: PositionalDefinition): YargsInstance
recommendCommands(recommend?: boolean): YargsInstance
require(): YargsInstance
keys: ,
max?: ,
| number
| string[]
| string
| true
msg?: string | true,
required(): YargsInstance
keys: ,
max?: ,
| number
| string[]
| string
| true
msg?: string | true,
requiresArg(keys: string | string[] | Dictionary): YargsInstance
scriptName(scriptName: string): YargsInstance
showCompletionScript($0?: string, cmd?: string): YargsInstance
showHelp(level: "error" | "log" | ((message: string) => void)): YargsInstance
showHelpOnFail(enabled?: string | boolean, message?: string): YargsInstance
showHidden(opt?: string | false, msg?: string): YargsInstance
showVersion(level: "error" | "log" | ((message: string) => void)): YargsInstance
skipValidation(keys: string | string[]): YargsInstance
strict(enabled?: boolean): YargsInstance
strictCommands(enabled?: boolean): YargsInstance
strictOptions(enabled?: boolean): YargsInstance
string(keys: string | string[]): YargsInstance
terminalWidth(): number | null
updateLocale(obj: Dictionary<string>): YargsInstance
updateStrings(obj: Dictionary<string>): YargsInstance
usage(): YargsInstance
msg: string | null,
description?: CommandHandler["description"],
builder?: CommandBuilderDefinition | CommandBuilder,
handler?: CommandHandlerCallback,
usageConfiguration(config: UsageConfiguration): this
version(): YargsInstance
opt?: string | false,
msg?: string,
ver?: string,
wrap(cols: number | nil): YargsInstance
[kCopyDoubleDash](argv: Arguments): any
[kCreateLogger](): LoggerInstance
[kDeleteFromParserHintObject](optionKey: string): void
[kEmitWarning](): void
warning: string,
type: string | undefined,
deduplicationId: string,
[kFreeze](): void
[kGetDollarZero](): string
[kGetHasOutput](): boolean
[kGetLoggerInstance](): LoggerInstance
[kGetParseContext](): Object
[kGuessLocale](): void
[kGuessVersion](): string
[kHasParseCallback](): boolean
[kIsGlobalContext](): boolean
[kParsePositionalNumbers](argv: Arguments): any
[kPkgUp](rootPath?: string): { [key: string]: string | { [key: string]: string; }; }
[kPopulateParserHintArray]<T extends KeyOf<Options, string[]>>(type: T, keys: string | string[]): void
[kPopulateParserHintArrayDictionary]<T extends DictionaryKeyof<Options, any[]>, K extends keyof Options[T] & string = keyof Options[T] & string, V extends ValueOf<ValueOf<Options[T]>> | ValueOf<ValueOf<Options[T]>>[] = ValueOf<ValueOf<Options[T]>> | ValueOf<ValueOf<Options[T]>>[]>(): void
builder: () => YargsInstance,
key: K,
value: V,
...otherArgs: any[],
type: T,
key: K | K[] | [key in K]: V,
value?: V,
[kPopulateParserHintDictionary]<T extends keyof Options, K extends keyof Options[T], V>(): void
builder: () => YargsInstance,
key: K,
value: V,
...otherArgs: any[],
type: T,
key: K | K[] | [key in K]: V,
value: V | undefined,
singleKeyHandler: () => void,
type: T,
key: K,
value?: V,
[kPopulateParserHintSingleValueDictionary]<T extends Exclude<DictionaryKeyof<Options>, DictionaryKeyof<Options, any[]>> | "default", K extends keyof Options[T] & string = keyof Options[T] & string, V extends ValueOf<Options[T]> = ValueOf<Options[T]>>(): void
builder: () => YargsInstance,
key: K,
value: V,
...otherArgs: any[],
type: T,
key: K | K[] | [key in K]: V,
value?: V,
[kPostProcess]<T extends Arguments | Promise<Arguments>>(): any
populateDoubleDash: boolean,
calledFromCommand: boolean,
runGlobalMiddleware: boolean,
[kRebase](base: string, dir: string): string
[kReset](aliases?: Aliases): YargsInstance
[kRunValidation](): (argv: Arguments) => void
aliases: Dictionary<string[]>,
positionalMap: Dictionary<string[]>,
parseErrors: Error | null,
isDefaultCommand?: boolean,
[kRunYargsParserAndExecuteCommands](): Arguments | Promise<Arguments>
args: string | string[] | null,
shortCircuit?: boolean | null,
calledFromCommand?: boolean,
commandIndex?: number,
helpOnly?: boolean,
[kSanitizeKey](key: any): any
[kSetHasOutput](): void
[kSetKey](key: string | string[] | Dictionary<string | boolean>, set?: boolean | string): this
[kTrackManuallySetKeys](keys: string | string[]): void
[kUnfreeze](): void