StringArgDefinition
Definition of a string arg.
- Import:
@kjanat/dreamcli - Export kind: interface
- Declared in:
src/core/schema/arg.ts - Source link:
src/core/schema/arg.ts:321
Signatures
ts
interface StringArgDefinition extends ArgDefinitionBase {}Members
Properties
configPath
Dotted config path for config resolution (e.g. 'deploy.region').
ts
configPath?: string;defaultValue
Runtime default value.
ts
defaultValue?: unknown;deprecated
Deprecation marker. true deprecates without a message, a string carries the migration guidance.
ts
deprecated?: string | true;description
Human-readable description for help text.
ts
description?: string;envVar
Environment variable name for env resolution.
ts
envVar?: string;kind
Kind discriminator.
ts
kind: "string";pathChecks
Filesystem checks applied after resolution.
ts
pathChecks?: PathChecks;presence
Presence state.
ts
presence?: "required" | "optional" | "defaulted";prompt
Interactive prompt configuration.
ts
prompt?: PromptConfig;stdin
Stdin binding. See StdinOptions.
ts
stdin?: StdinOptions;stringConstraints
String constraints enforced at the parse and resolution boundaries.
ts
stringConstraints?: StringConstraints;valueHint
Help placeholder label ('url', 'path', …).
ts
valueHint?: string;variadic
Whether this arg consumes all remaining positionals.
ts
variadic?: boolean;