@salesforce/core
    Preparing search index...

    Type Alias ConfigPropertyMeta

    Interface for meta information about config properties

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

    True if the property is deprecated

    description: string

    Description

    encrypted?: boolean

    True if the property values should be stored encrypted.

    hidden?: boolean

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

    input?: ConfigPropertyMetaInput

    Reference to the config data input validation.

    key: string

    The config property name.

    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

    On This Page
    Properties