Module

x/yargs/build/lib/usage.d.ts>UsageInstance

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

Methods

cacheHelpMessage(): void
clearCachedHelpMessage(): void
hasCachedHelpMessage(): boolean
command(
cmd: string,
description: string | undefined,
isDefault: boolean,
aliases: string[],
deprecated?: boolean,
): void
deferY18nLookup(str: string): string
describe(keys: string | string[] | Dictionary<string>, desc?: string): void
epilog(msg: string): void
example(cmd: string, description?: string): void
fail(msg?: string | null, err?: YError | string): void
failFn(f: FailureFunction | boolean): void
freeze(): void
functionDescription(fn: { name?: string; }): string
getCommands():
[
string,
string,
boolean,
string[],
boolean,
]
[]
getDescriptions(): Dictionary<string | undefined>
getPositionalGroupName(): string
getUsage(): [string, string][]
getUsageDisabled(): boolean
getWrap(): number | nil
help(): string
reset(localLookup: Dictionary<boolean>): UsageInstance
showHelp(level?: "error" | "log" | ((message: string) => void)): void
showHelpOnFail(enabled?: boolean | string, message?: string): UsageInstance
showVersion(level?: "error" | "log" | ((message: string) => void)): void
stringifiedValues(values?: any[], separator?: string): string
unfreeze(defaultCommand?: boolean): void
usage(msg: string | null, description?: string | false): UsageInstance
version(ver: any): void
wrap(cols: number | nil): void