Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

x/yargs/build/lib/yargs-factory.js>YargsInstance

yargs the modern, pirate-themed successor to optimist.
yargs/yargs
Latest
class YargsInstance
import { YargsInstance } from "https://deno.land/x/yargs@v17.7.2-deno/build/lib/yargs-factory.js";

Constructors

new
YargsInstance(
processArgs?,
cwd,
parentRequire,
shim,
)

Methods

addHelpOpt(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)
example(cmd, description)
exit(code, err)
exitProcess(enabled?)
fail(f)
getCompletion(args, done)
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,
)
parseSync(
args,
shortCircuit,
_parseFn,
)
pkgConf(key, rootPath)
positional(key, opts)
recommendCommands(recommend?)
require(
keys,
max,
msg,
)
required(
keys,
max,
msg,
)
scriptName(scriptName)
showHelp(level)
showHelpOnFail(enabled, message)
showHidden(opt, msg)
strict(enabled)
strictOptions(enabled)
string(keys)
usage(
msg,
description,
builder,
handler,
)
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)
[kCreateLogger]()
[kDeleteFromParserHintObject](optionKey)
[kEmitWarning](
warning,
type,
deduplicationId,
)
[kFreeze]()
[kGetCommandInstance]()
[kGetContext]()
[kGetDollarZero]()
[kGetHasOutput]()
[kGetLoggerInstance]()
[kGetParseContext]()
[kGetParserConfiguration]()
[kGetUsageConfiguration]()
[kGetUsageInstance]()
[kGetValidationInstance]()
[kGuessLocale]()
[kGuessVersion]()
[kHasParseCallback]()
[kIsGlobalContext]()
[kParsePositionalNumbers](argv)
[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)
[kSetHasOutput]()
[kSetKey](key, set)
[kTrackManuallySetKeys](keys)
[kUnfreeze]()
[kValidateAsync](validation, argv)