Module

x/yargs/build/lib/yargs-factory.d.ts>OptionDefinition

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

Properties

optional
alias: string | string[]
optional
array: boolean
optional
boolean: boolean
optional
choices: string | string[]
optional
coerce: CoerceCallback
optional
config: boolean
optional
configParser: ConfigCallback
optional
conflicts: string | string[]
optional
count: boolean
optional
default: any
optional
defaultDescription: string
optional
deprecate: string | boolean
optional
deprecated: OptionDefinition["deprecate"]
optional
desc: string
optional
describe: OptionDefinition["desc"]
optional
description: OptionDefinition["desc"]
optional
demand: string | true
optional
demandOption: OptionDefinition["demand"]
optional
global: boolean
optional
group: string
optional
hidden: boolean
optional
implies: string | number | KeyOrPos[]
optional
nargs: number
optional
normalize: boolean
optional
number: boolean
optional
require: OptionDefinition["demand"]
optional
required: OptionDefinition["demand"]
optional
requiresArg: boolean
optional
skipValidation: boolean
optional
string: boolean
optional
type:
| "array"
| "boolean"
| "count"
| "number"
| "string"