Backstage
    Preparing search index...

    Interface ConfigSourcesDefaultOptions

    Options for ConfigSources.default.

    interface ConfigSourcesDefaultOptions {
        allowMissingDefaultConfig?: boolean;
        argv?: string[];
        env?: Record<string, string | undefined>;
        remote?: Pick<RemoteConfigSourceOptions, "reloadInterval">;
        rootDir?: string;
        substitutionFunc?: EnvFunc;
        watch?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    allowMissingDefaultConfig? argv? env? remote? rootDir? substitutionFunc? watch?

    Properties

    allowMissingDefaultConfig?: boolean

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

    argv?: string[]
    env?: Record<string, string | undefined>
    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.

    watch?: boolean

    Settings

    Member Visibility

    On This Page

    Properties