dub-mirrors/mirage-config
1
0
Fork 0
mirror of https://github.com/mbierlee/mirage-config.git synced 2024-11-14 20:34:00 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add documentation to loadConfig

Browse source
This commit is contained in:
Mike Bierlee 2022-10-31 22:07:13 +03:00
parent fec9c1ab71
commit 973317bab5
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
source/mirage/config.d
View file

@ -594,6 +594,14 @@ abstract class ConfigFactory {
ConfigDictionary parseConfig(string contents); ConfigDictionary parseConfig(string contents);
} }
/**
* Load config from disk.
* A specific loader will be used based on the file's extension.
* Params:
* configPath = Path to the configuration file.
* Returns: The loaded configuration.
* Throws: ConfigCreationException when the file's extension is unrecognized.
*/
ConfigDictionary loadConfig(const string configPath) { ConfigDictionary loadConfig(const string configPath) {
auto extension = configPath.extension.toLower; auto extension = configPath.extension.toLower;
if (extension == ".json") { if (extension == ".json") {