Type alias BaseOptions<TRequired, TDefault>

BaseOptions<TRequired, TDefault>: {
    description?: string;
    label?: string;
    required?: TRequired;
} & DefaultValue<TDefault>

Type Parameters

  • TRequired

  • TDefault

Type declaration

  • Optional description?: string
  • Optional label?: string

    A cosmetic label for this option, used when displaying it

    Changing the label will not alter the user provided value in any way unlike changing the "name" for the option.

  • Optional required?: TRequired

    Whether this setting is required, this can only be set on top level options if a default value is provided.

Generated using TypeDoc