Header menu logo UnionConfig

ConfigEditor Module

Shared config editing operations parameterized by backend

Types

Type Description

PopulateResult

Result of populating defaults

Functions and values

Function or value Description

editConfig loadConfig setValue writeConfigFile verifyChanges

Full Usage: editConfig loadConfig setValue writeConfigFile verifyChanges

Parameters:
    loadConfig : unit -> Map<string, string>
    setValue : string -> string -> bool
    writeConfigFile : string -> Map<string, string> -> unit
    verifyChanges : (string * string * string) array -> Map<string, string> -> (string * VerificationResult) array

Edit config via editor workflow Parameters: - loadConfig: function to load all config - setValue: function to set a single value - writeConfigFile: function to write config to a file (path -> config -> unit) - verifyChanges: function to verify changed values (returns verification results)

loadConfig : unit -> Map<string, string>
setValue : string -> string -> bool
writeConfigFile : string -> Map<string, string> -> unit
verifyChanges : (string * string * string) array -> Map<string, string> -> (string * VerificationResult) array

populateDefaults getValue setValue getDefaults writeLocalFile

Full Usage: populateDefaults getValue setValue getDefaults writeLocalFile

Parameters:
    getValue : string -> string option
    setValue : string -> string -> bool
    getDefaults : Map<string, string> -> (string * string) array
    writeLocalFile : Map<string, string> -> unit

Returns: PopulateResult

Populate defaults directly (no editor) Parameters: - getValue: function to get current value for a name - setValue: function to set a value, returns true on success - getDefaults: function that returns (name, defaultValue) pairs for vars that need defaults - writeLocalFile: optional function to write updated config to local file

getValue : string -> string option
setValue : string -> string -> bool
getDefaults : Map<string, string> -> (string * string) array
writeLocalFile : Map<string, string> -> unit
Returns: PopulateResult

Type something to start searching.