Module

x/yargs/build/lib/command.d.ts>CommandInstance

yargs the modern, pirate-themed successor to optimist.
Go to Latest
class CommandInstance
import { CommandInstance } from "https://dotland.deno.dev/x/yargs@v17.7.1-deno/build/lib/command.d.ts";

Constructors

new
CommandInstance(
validation: ValidationInstance,
globalMiddleware: GlobalMiddleware,
)

Properties

private
applyBuilderUpdateUsageAndParse
private
applyMiddlewareAndGetResult
private
commandFromFilename
private
extractDesc
private
handleValidationAndGetResult
private
moduleName
private
parseAndUpdateUsage
private
populatePositional
private
populatePositionals
private
postProcessPositionals
private
shouldUpdateUsage
private
usageFromParentCommandsCommandHandler
aliasMap: Dictionary<string>
optional
defaultCommand: CommandHandler
frozens: FrozenCommandInstance[]
globalMiddleware: GlobalMiddleware
requireCache: Set<string>
validation: ValidationInstance

Methods

addDirectory(
dir: string,
req: Function,
callerFile: string,
): void
addHandler(
description?: CommandHandler["description"],
commandMiddleware?: Middleware[],
deprecated?: boolean,
): void
cmdToParseOptions(cmdString: string): Positionals
freeze(): void
getCommands(): string[]
isDefaulted(yargs: YargsInstance, key: string): boolean
isInConfigs(yargs: YargsInstance, key: string): boolean
runCommand(
command: string | null,
commandIndex: number,
helpOnly: boolean,
helpOrVersionSet: boolean,
): Arguments | Promise<Arguments>
runDefaultBuilderOn(yargs: YargsInstance): unknown | Promise<unknown>
unfreeze(): void