Skip to content

FlagElementFragmentV1 ​

A collection flag's element fragment, excluding input-level metadata.

Signatures ​

ts
type FlagElementFragmentV1 = 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;

duplicateKeys ​

ts
duplicateKeys?: DuplicateKeys;

duplicates ​

ts
duplicates?: DuplicatePolicy;

elementSchema ​

ts
elementSchema?: FlagElementFragmentV1;

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;

split ​

ts
split?: SourceSplitFragmentV1;

stdin ​

ts
stdin?: StdinBindingFragmentV1;

stringConstraints ​

ts
stringConstraints?: FlagStringConstraintsFragmentV1;

unique ​

ts
unique?: true;

valueHint ​

ts
valueHint?: string;

See Also ​

Released under the MIT License.