Type alias ConfigPropertyMeta

ConfigPropertyMeta: {
    deprecated?: boolean;
    description: string;
    encrypted?: boolean;
    hidden?: boolean;
    input?: ConfigPropertyMetaInput;
    key: string;
    newKey?: string;
}

Interface for meta information about config properties

Type declaration

  • Optional deprecated?: boolean

    True if the property is deprecated

  • description: string

    Description

  • Optional encrypted?: boolean

    True if the property values should be stored encrypted.

  • Optional hidden?: boolean

    True if the property should be indirectly hidden from the user.

  • Optional input?: ConfigPropertyMetaInput

    Reference to the config data input validation.

  • key: string

    The config property name.

  • Optional newKey?: string

    Reference to config property name that will eventually replace this one. Is only used if deprecated is set to true.

Settings

Member Visibility

Theme