Skip to content

getFlagNegatedName

Generated reference page for the getFlagNegatedName function export.

Signatures

ts
function getFlagNegatedName(name: string, schema: FlagSchema): string | undefined;
ParameterTypeDescription
namestringCanonical flag name.
schemaFlagSchemaFlag schema (read for FlagNegation).

Members

Members

getFlagNegatedName

Effective negated spelling for a flag, or undefined when not negatable.

The builder cannot know its flag name, so a default (no-<name>) is synthesized here — everywhere the canonical name is known (parser, help, completions, collision validation).

ts
(name: string, schema: FlagSchema): string | undefined;

See Also

Released under the MIT License.