@fp8/simple-config
    Preparing search index...

    Interface IConfigStoreOptions

    ConfigStore creation option

    interface IConfigStoreOptions {
        configFileName?: string;
        createAndValidateFunction?: <T extends object | IEntityCreator>(
            type: new () => T,
            data: unknown,
            options?: EntityCreatorOptions,
        ) => T;
        createOptions?: ClassTransformOptions;
        disableValidation?: boolean;
        entries?: IJson;
        env?: string;
        externalValidationFunction?: (obj: unknown) => void;
        loadAll?: boolean;
        templateTags?: [string, string];
        validateModelOptions?: ValidateModelOptions;
    }

    Hierarchy (View Summary)

    Index

    Properties

    configFileName? createAndValidateFunction? createOptions? disableValidation? entries? env? externalValidationFunction? loadAll? templateTags? validateModelOptions?

    Properties

    configFileName?: string

    Set the name of config file to read. Must be a .json file and defaults to config.json

    createAndValidateFunction?: <T extends object | IEntityCreator>(
        type: new () => T,
        data: unknown,
        options?: EntityCreatorOptions,
    ) => T

    Custom createAndValidate function

    createOptions?: ClassTransformOptions

    Optional class-transformer options

    disableValidation?: boolean

    Disable Validation

    entries?: IJson

    Addtional entries to be added to data loaded

    env?: string

    Provide env string to use to look for config file. Default to FP8_ENV environmental variable or local.

    externalValidationFunction?: (obj: unknown) => void

    Custom external validation function that ignores validateModelOptions but still respects disableValidation

    loadAll?: boolean

    If set, load all config files from the config directory

    templateTags?: [string, string]

    Define open and closing tag for mustache. Default to ['{{', '}}']

    validateModelOptions?: ValidateModelOptions

    Optional class-validator options

    Settings

    Member Visibility

    On This Page

    Properties