ICfgRoot

The main configuration root interface.

Properties

ConfigChanges

Observable stream of configuration changes.

IObservable<ConfigChangeEvent> ConfigChanges { get; }

Methods

Indexer

Get or set a configuration value using indexer syntax.

string? this[string key] { get; set; }

GetValue

Get a typed configuration value.

T? GetValue<T>(string key)

Exists

Check if a key exists.

bool Exists(string key)

GetSection

Get a configuration section.

ICfgSection GetSection(string key)

Set

Set a configuration value.

void SetValue(string key, string? value, int? targetLevel = null)

Remove

Remove a configuration key.

void Remove(string key, int? targetLevel = null)

SaveAsync

Save pending changes.

Task SaveAsync(int? targetLevel = null, CancellationToken ct = default)

GetMany

Get multiple values.

IReadOnlyDictionary<string, string?> GetMany(IEnumerable<string> keys)
void GetMany(IEnumerable<string> keys, Action<string, string?> onValue)

SetMany

Set multiple values.

void SetManyValues(IEnumerable<KeyValuePair<string, string?>> values, int? targetLevel = null)

ToMicrosoftConfiguration

Convert to IConfigurationRoot.

IConfigurationRoot ToMicrosoftConfiguration()

Example

// Read
var name = cfg["App:Name"];
var port = cfg.GetValue<int>("App:Port");

// Write
cfg.SetValue("App:Name", "NewName");
await cfg.SaveAsync();

// Subscribe to changes
cfg.ConfigChanges.Subscribe(e => Console.WriteLine("Changed!"));

Next Steps

• ICfgSection - Section interface
• CfgBuilder - Builder API