Backstage
    Preparing search index...

    Interface ConfigSourceData

    The data returned by ConfigSource.readConfigData.

    interface ConfigSourceData {
        context: string;
        data: JsonObject;
        deprecatedKeys?: { description: string; key: string }[];
        filteredKeys?: string[];
        path?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    context data deprecatedKeys? filteredKeys? path?

    Properties

    context: string

    A string representing the source of this configuration data, for example a filepath.

    data: JsonObject

    The configuration data itself.

    deprecatedKeys?: { description: string; key: string }[]

    A list of deprecated keys that were found in the configuration when it was loaded.

    This can be used to warn the user if they are using deprecated properties.

    filteredKeys?: string[]

    A list of keys that where filtered out from the configuration when it was loaded.

    This can be used to warn the user if they try to read any of these keys.

    path?: string

    The file path that this configuration was loaded from, if it was loaded from a file.

    Settings

    Member Visibility

    On This Page

    Properties