Skip to content

ArgDefinitionFragmentV1

A positional arg entry inside a definition document.

Array order carries the CLI position.

Signatures

ts
type ArgDefinitionFragmentV1 = unknown;

Members

Properties

configPath

ts
configPath?: string;

defaultValue

ts
defaultValue?: unknown;

deprecated

ts
deprecated?: string | true;

description

ts
description?: string;

duplicateKeys

ts
duplicateKeys?: DuplicateKeys;

enumValues

ts
enumValues?: readonly string[];

envVar

ts
envVar?: string;

kind

ts
kind: ArgKind;

name

ts
name: string;

numberConstraints

ts
numberConstraints?: NumberConstraints;

pathChecks

ts
pathChecks?: FlagPathChecksFragmentV1;

presence

ts
presence: ArgPresence;

prompt

ts
prompt?: PromptDefinitionFragmentV1;

separator

ts
separator?: string;

split

ts
split?: SourceSplitFragmentV1;

stdin

ts
stdin?: StdinBindingFragmentV1;

stringConstraints

ts
stringConstraints?: FlagStringConstraintsFragmentV1;

unique

ts
unique?: true;

valueHint

ts
valueHint?: string;

variadic

ts
variadic?: true;

See Also

Released under the MIT License.