Backstage
    Preparing search index...

    Interface ConfigSourcesDefaultForTargetsOptions

    Options for ConfigSources.defaultForTargets.

    interface ConfigSourcesDefaultForTargetsOptions {
        allowMissingDefaultConfig?: boolean;
        remote?: Pick<RemoteConfigSourceOptions, "reloadInterval">;
        rootDir?: string;
        substitutionFunc?: EnvFunc;
        targets: ConfigSourceTarget[];
        watch?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    allowMissingDefaultConfig? remote? rootDir? substitutionFunc? targets watch?

    Properties

    allowMissingDefaultConfig?: boolean

    Allow the default app-config.yaml to be missing, in which case the source will not be created.

    remote?: Pick<RemoteConfigSourceOptions, "reloadInterval">
    rootDir?: string
    substitutionFunc?: EnvFunc

    A custom substitution function that overrides the default one.

    The substitution function handles syntax like ${MY_ENV_VAR} in configuration values. The default substitution will read the value from the environment and trim whitespace.

    targets: ConfigSourceTarget[]
    watch?: boolean

    Settings

    Member Visibility

    On This Page

    Properties