FlagDefinitionFragmentV1
A flag entry inside a definition document.
Optional fields appear only when the flag sets them; defaultValue appears only when the value survives a JSON round-trip.
- Import:
@kjanat/dreamcli - Export kind: type
- Declared in:
src/core/json-schema/index.ts - Source link:
src/core/json-schema/index.ts:206
Signatures
ts
type FlagDefinitionFragmentV1 = unknown;Members
Properties
aliases
ts
aliases?: readonly string[];configPath
ts
configPath?: string;defaultValue
ts
defaultValue?: unknown;deprecated
ts
deprecated?: string | true;description
ts
description?: string;duplicates
ts
duplicates?: DuplicatePolicy;elementSchema
ts
elementSchema?: FlagDefinitionFragmentV1;enumValues
ts
enumValues?: readonly string[];envVar
ts
envVar?: string;kind
ts
kind: FlagKind;negation
ts
negation?: FlagNegationFragmentV1;numberConstraints
ts
numberConstraints?: NumberConstraints;pathChecks
ts
pathChecks?: FlagPathChecksFragmentV1;presence
ts
presence: FlagPresence;prompt
ts
prompt?: PromptDefinitionFragmentV1;propagate
ts
propagate?: true;separator
ts
separator?: string;stdin
ts
stdin?: StdinBindingFragmentV1;stringConstraints
ts
stringConstraints?: FlagStringConstraintsFragmentV1;unique
ts
unique?: true;valueHint
ts
valueHint?: string;