Skip to content

ArgDefinitionFragmentV1 ​

A positional arg entry inside a definition document.

Array order carries the CLI position.

Signatures ​

ts
type ArgDefinitionFragmentV1 = { name: string; kind: ArgKind; presence: ArgPresence; variadic?: true; stdin?: StdinBindingFragmentV1; defaultValue?: unknown; defaultDescription?: string | false; sensitive?: true; description?: string; group?: string; envVar?: string; envIndexed?: EnvIndexedFragmentV1; envAbsolute?: true; configPath?: string; enumValues?: readonly string[]; elementSchema?: ArgElementFragmentV1; numberConstraints?: NumberConstraints; stringConstraints?: FlagStringConstraintsFragmentV1; pathChecks?: FlagPathChecksFragmentV1; valueHint?: string; separator?: string; split?: SourceSplitFragmentV1; duplicateKeys?: DuplicateKeys; unique?: true; prompt?: PromptDefinitionFragmentV1; deprecated?: string | true; };

Members ​

Members ​

name ​

ts
name: string;

kind ​

ts
kind: ArgKind;

presence ​

ts
presence: ArgPresence;

variadic ​

ts
variadic?: true;

stdin ​

ts
stdin?: StdinBindingFragmentV1;

defaultValue ​

ts
defaultValue?: unknown;

defaultDescription ​

ts
defaultDescription?: string | false;

sensitive ​

ts
sensitive?: true;

description ​

ts
description?: string;

group ​

Named arguments section in command help.

ts
group?: string;

envVar ​

ts
envVar?: string;

envIndexed ​

ts
envIndexed?: EnvIndexedFragmentV1;

envAbsolute ​

ts
envAbsolute?: true;

configPath ​

ts
configPath?: string;

enumValues ​

ts
enumValues?: readonly string[];

elementSchema ​

ts
elementSchema?: ArgElementFragmentV1;

numberConstraints ​

ts
numberConstraints?: NumberConstraints;

stringConstraints ​

ts
stringConstraints?: FlagStringConstraintsFragmentV1;

pathChecks ​

ts
pathChecks?: FlagPathChecksFragmentV1;

valueHint ​

ts
valueHint?: string;

separator ​

ts
separator?: string;

split ​

ts
split?: SourceSplitFragmentV1;

duplicateKeys ​

ts
duplicateKeys?: DuplicateKeys;

unique ​

ts
unique?: true;

prompt ​

ts
prompt?: PromptDefinitionFragmentV1;

deprecated ​

ts
deprecated?: string | true;

See Also ​

Released under the MIT License.