vulcain-corejs/lib/src/globals/settings.d.ts

Vulcain micro-service framework

/**
 * Manage local file settings
 */
export declare class Settings {
    private _environment;
    private _stubs;
    private _config;
    private _alias;
    private _settings;
    constructor();
    readonly environment: "local" | "test" | "production";
    readonly stubSessions: {
        [name: string]: string;
    };
    saveStubSessions(stubSessions: any): Promise<any>;
    /**
     * Read configurations from vulcain file
     * Set env type from environment variable then vulcain config
     *
     * @private
     */
    private readContext();
    /**
     * Check if the service is running in local mode
     *
     * @readonly
     * @static
     *
     * @memberOf System
     */
    readonly isDevelopment: boolean;
    /**
     * Check if the current service is running in test environnement
     *
     * @static
     * @returns
     *
     * @memberOf System
     */
    readonly isTestEnvironment: boolean;
    getSettings(name: string): any;
    /**
     * Resolve service alias
     *
     * @param {string} name
     * @param {string} [version]
     * @returns null if no alias exists
     *
     * @memberOf System
     */
    getAlias(name: string, version?: string): string;
}