import { YargsInstance } from "https://dotland.deno.dev/x/yargs@v17.7.1-deno/build/lib/yargs-factory.js";
Methods
addHelpOpt(opt, msg)
addShowHiddenOpt(opt, msg)
alias(key, value)
array(keys)
boolean(keys)
check(f, global)
choices(key, value)
coerce(keys, value)
command()
cmd,
description,
builder,
handler,
middlewares,
deprecated,
commandDir(dir, opts)
commands()
cmd,
description,
builder,
handler,
middlewares,
deprecated,
completion()
cmd,
desc,
fn,
config()
key?,
msg,
parseFn,
conflicts(key1, key2)
count(keys)
default()
key,
value,
defaultDescription,
defaults()
key,
value,
defaultDescription,
demand()
keys,
max,
msg,
demandCommand()
min?,
max,
minMsg,
maxMsg,
demandOption(keys, msg)
deprecateOption(option, message)
describe(keys, description)
detectLocale(detect)
env(prefix)
epilog(msg)
epilogue(msg)
example(cmd, description)
exit(code, err)
exitProcess(enabled?)
fail(f)
getCompletion(args, done)
getHelp()
global(globals, global)
group(opts, groupName)
help(opt, msg)
hide(key)
implies(key, value)
locale(locale)
middleware()
callback,
applyBeforeValidation,
global,
nargs(key, value)
normalize(keys)
number(keys)
option(key, opt)
options(key, opt)
parse()
args,
shortCircuit,
_parseFn,
parseAsync()
args,
shortCircuit,
_parseFn,
parserConfiguration(config)
parseSync()
args,
shortCircuit,
_parseFn,
pkgConf(key, rootPath)
positional(key, opts)
recommendCommands(recommend?)
require()
keys,
max,
msg,
required()
keys,
max,
msg,
requiresArg(keys)
scriptName(scriptName)
showCompletionScript($0, cmd)
showHelp(level)
showHelpOnFail(enabled, message)
showHidden(opt, msg)
showVersion(level)
skipValidation(keys)
strict(enabled)
strictCommands(enabled)
strictOptions(enabled)
string(keys)
updateLocale(obj)
updateStrings(obj)
usage()
msg,
description,
builder,
handler,
usageConfiguration(config)
version()
opt,
msg,
ver,
wrap(cols)
[(_YargsInstance_command = new WeakMap(), _YargsInstance_cwd = new WeakMap(), _YargsInstance_context = new WeakMap(), _YargsInstance_completion = new WeakMap(), _YargsInstance_completionCommand = new WeakMap(), _YargsInstance_defaultShowHiddenOpt = new WeakMap(), _YargsInstance_exitError = new WeakMap(), _YargsInstance_detectLocale = new WeakMap(), _YargsInstance_emittedWarnings = new WeakMap(), _YargsInstance_exitProcess = new WeakMap(), _YargsInstance_frozens = new WeakMap(), _YargsInstance_globalMiddleware = new WeakMap(), _YargsInstance_groups = new WeakMap(), _YargsInstance_hasOutput = new WeakMap(), _YargsInstance_helpOpt = new WeakMap(), _YargsInstance_isGlobalContext = new WeakMap(), _YargsInstance_logger = new WeakMap(), _YargsInstance_output = new WeakMap(), _YargsInstance_options = new WeakMap(), _YargsInstance_parentRequire = new WeakMap(), _YargsInstance_parserConfig = new WeakMap(), _YargsInstance_parseFn = new WeakMap(), _YargsInstance_parseContext = new WeakMap(), _YargsInstance_pkgs = new WeakMap(), _YargsInstance_preservedGroups = new WeakMap(), _YargsInstance_processArgs = new WeakMap(), _YargsInstance_recommendCommands = new WeakMap(), _YargsInstance_shim = new WeakMap(), _YargsInstance_strict = new WeakMap(), _YargsInstance_strictCommands = new WeakMap(), _YargsInstance_strictOptions = new WeakMap(), _YargsInstance_usage = new WeakMap(), _YargsInstance_usageConfig = new WeakMap(), _YargsInstance_versionOpt = new WeakMap(), _YargsInstance_validation = new WeakMap(), kCopyDoubleDash)](argv)
[kDeleteFromParserHintObject](optionKey)
[kEmitWarning]()
warning,
type,
deduplicationId,
[kPkgUp](rootPath)
[kPopulateParserHintArray](type, keys)
[kPopulateParserHintArrayDictionary]()
builder,
type,
key,
value,
[kPopulateParserHintDictionary]()
builder,
type,
key,
value,
singleKeyHandler,
[kPopulateParserHintSingleValueDictionary]()
builder,
type,
key,
value,
[kPostProcess]()
argv,
populateDoubleDash,
calledFromCommand,
runGlobalMiddleware,
[kRebase](base, dir)
[kReset](aliases?)
[kRunValidation]()
aliases,
positionalMap,
parseErrors,
isDefaultCommand,
[kRunYargsParserAndExecuteCommands]()
args,
shortCircuit,
calledFromCommand,
commandIndex?,
helpOnly?,
[kSanitizeKey](key)
[kSetKey](key, set)
[kTrackManuallySetKeys](keys)
[kValidateAsync](validation, argv)