vulcain-corejs/dist/configurations/dynamicConfiguration.d.ts

Vulcain micro-service framework

import { DynamicProperties as DP } from './properties/dynamicProperties';
import { IDynamicProperty } from './dynamicProperty';
import { ConfigurationSourceBuilder } from './configurationSources/configurationSourceBuilder';
/**
 *
* Provides dynamic properties updated when config change.
* Accessing a dynamic property is very fast. The last value is cached and updated on the fly
* from a <b>ConfigurationSource</b> at fixed interval.
* Updates are made using polling requests on a list of sources.
* <p>
* Dynamic properties are read only. You can set a value but it will be valid only as a default value.
* </p>
* <code>
* DynamicConfiguration.init().addRest("http....").startPollingAsync();
* let i:number = DynamicConfiguration.getProperty("prop1");
* let i2:number = DynamicConfiguration.getOrDefaultProperty("prop1", 1);
* </code>
*/
export declare class DynamicConfiguration {
    /**
     * subscribe on a property changed
     */
    static onPropertyChanged<T>(handler: (e: IDynamicProperty<T>) => void, propertyName?: string): void;
    /**
     * Create a chained property
     *
     */
    static asChainedProperty<T>(defaultValue: T, name: string, ...fallbackPropertyNames: Array<string>): IDynamicProperty<T>;
    /**
     * Create a new property
     */
    static asProperty<T>(value: T, name?: string, onPropertyChanged?: (e: IDynamicProperty<T>) => void): IDynamicProperty<T>;
    /**
     * Get a property value by name
     *
     * @static
     * @template T
     * @param {string} name
     * @returns
     *
     * @memberOf DynamicConfiguration
     */
    static get<T>(name: string): any;
    /**
     * Get a dynamic property
     */
    static getProperty<T>(name: string): IDynamicProperty<T>;
    /**
     * Get or create a dynamic property
     * defaultValue can be a value or a factory
     */
    static getOrCreateProperty<T>(name: string, defaultValue: T): IDynamicProperty<T>;
    /**
     * Update a property value or create a new one if not exists
     */
    static setOrCreateProperty<T>(name: string, defaultValue: () => IDynamicProperty<T> | T): IDynamicProperty<T>;
    /**
     * Init polling informations. This function can be call only once before any use of a dynamic property.
     */
    static init(pollingIntervalInSeconds?: number, sourceTimeoutInMs?: number): ConfigurationSourceBuilder;
    static reset(pollingIntervalInSeconds?: number, sourceTimeoutInMs?: number): void;
    /**
     * Get the underlying dynamic properties manager instance
     */
    static instance: DP;
}