NumberFlagDefinition
Definition of a number flag.
- Import:
@kjanat/dreamcli - Export kind: interface
- Declared in:
src/core/schema/flag.ts - Source link:
src/core/schema/flag.ts:625
Signatures
interface NumberFlagDefinition extends FlagDefinitionBase {}Members
Properties
kind
Kind discriminator.
kind: "number";numberConstraints
Numeric constraints enforced at the parse and resolution boundaries.
numberConstraints?: NumberConstraints | undefined;completion
Callback used to complete this input's values.
completion?: CompletionHandler | undefined;completionValues
Static shell completion suggestions for this flag.
completionValues?: readonly string[] | undefined;presence
Presence state.
presence?: FlagPresence | undefined;defaultValue
Runtime default value.
defaultValue?: unknown;defaultDescription
Human-readable replacement for the default value in help, or false to omit the default annotation.
defaultDescription?: string | false | undefined;sensitive
Whether values from this input must be kept out of user-facing projections.
sensitive?: boolean | undefined;aliases
Short/long aliases as bare names or FlagAlias records.
aliases?: readonly (string | FlagAlias)[] | undefined;stdin
Stdin binding. See StdinOptions.
stdin?: StdinOptions | undefined;envVar
Environment variable name for env resolution.
envVar?: string | undefined;envIndexed
Indexed environment family read as the env source, in place of FlagDefinitionBase.envVar. Requires kind 'array' or 'custom'.
envIndexed?: IndexedEnvBinding | undefined;envAbsolute
Read the env source exactly as written, outside the CLI-wide namespace. Requires envVar or envIndexed.
envAbsolute?: boolean | undefined;envFromName
Derive envVar from the registered name.
envFromName?: boolean | undefined;configPath
Dotted config path for config resolution (e.g. 'deploy.region').
configPath?: string | undefined;description
Human-readable description for help text.
description?: HelpDescription | undefined;group
Named section in command help.
group?: string | undefined;advanced
Whether the flag is shown only in full text help.
advanced?: true | undefined;valueHint
Help placeholder label ('url' renders as <url>).
valueHint?: string | undefined;prompt
Interactive prompt configuration.
prompt?: PromptConfig | undefined;standard
Standard Schema v1 validator applied to each resolved value.
standard?: StandardSchemaV1 | undefined;aggregateStandard
Standard Schema v1 validator applied to a completed collection.
aggregateStandard?: StandardSchemaV1 | undefined;deprecated
Deprecation marker. true deprecates without a message, a string carries the migration guidance.
deprecated?: string | true | undefined;propagate
Whether the flag propagates to descendant commands.
propagate?: boolean | undefined;duplicates
How repeated CLI occurrences combine. See DuplicatePolicy.
duplicates?: DuplicatePolicy | undefined;