Interface FlagsDeclarationOption<T>

interface FlagsDeclarationOption<T> {
    defaults: T;
    help: string | ((i18n: TranslationProxy) => string);
    name: string;
    type: Flags;
    configFileOnly?: boolean;
}

Type Parameters

  • T extends Record<string, boolean>

Hierarchy (view full)

Properties

defaults help name type configFileOnly?

Properties

defaults

defaults: T

All of the possible flags, with their default values set.

help

help: string | ((i18n: TranslationProxy) => string)

The help text to be displayed to the user when --help is passed.

This may be a string, which will be presented directly, or a function, which will be called with an TranslationProxy so that option help can be translated into the user specified locale.

name

name: string

The option name.

type

type: Flags

The parameter type, used to convert user configuration values into the expected type. If not set, the type will be a string.

OptionalconfigFileOnly

configFileOnly?: boolean

If set, this option will be omitted from --help, and attempting to specify it on the command line will produce an error.

Settings

Member Visibility

On This Page

Properties