node-microsvc-lib/lib/service_params.d.ts

NodeJS microservice framework library

export declare enum ParamTypes {
    "STRING" = "STRING",
    "BOOL" = "BOOL",
    "INT_NUMBER" = "INT_NUMBER",
    "FLOAT_NUMBER" = "FLOAT_NUMBER"
}
/** type from string enum */
/***
 * ServiceParams
 * An instance of this class is required to configure a service.
 * This will act like the schema of available of parameters, feature flags and secrets for a service.
 */
export declare class ServiceParams {
    private _uppercase_key_names;
    private _original_key_names;
    private _params;
    private _feature_flags;
    private _secrets;
    constructor();
    has(name: string): boolean;
    private _register_key_name;
    all_keys(): string[];
    private _check_name;
    add_param(name: string, type: ParamTypes, default_value: any, description: string): void;
    get_param(param_name: string): ServiceParam | null;
    get_all_params(): Array<ServiceParam>;
    add_feature_flag(name: string, default_value: boolean, description: string): void;
    get_feature_flag(feature_flag_name: string): ServiceFeatureFlag | null;
    get_all_feature_flags(): Array<ServiceFeatureFlag>;
    add_secret(name: string, default_value: string | null, description: string): void;
    get_secret(secret_name: string): ServiceSecret | null;
    get_all_secrets(): Array<ServiceSecret>;
}
export declare class ServiceParam {
    private _name;
    private _type;
    private _default_value;
    private _description;
    constructor(_name: string, _type: ParamTypes, _default_value: any, _description: string);
    get name(): string;
    get type(): ParamTypes;
    get default_value(): any;
    get description(): string;
}
export declare class ServiceFeatureFlag {
    private _name;
    private _default_value;
    private _description;
    constructor(_name: string, _default_value: boolean, _description: string);
    get name(): string;
    get default_value(): boolean;
    get description(): string;
}
export declare class ServiceSecret {
    private _name;
    private _default_value;
    private _description;
    constructor(_name: string, _default_value: string | null, _description: string);
    get name(): string;
    get default_value(): string | null;
    get description(): string;
}