YAML Configuration Source

YAML provides a human-readable configuration format with support for complex hierarchies.

Installation

dotnet add package Apq.Cfg.Yaml

Default Level

The default level for this configuration source is CfgSourceLevels.Yaml (0).

If you don't specify the level parameter, the default level will be used:

// Uses default level 0
.AddYamlFile("config.yaml")

// Specify custom level
.AddYamlFile("config.yaml", level: 10)

Basic Usage

Configuration File

App:
  Name: MyApp
  Port: 8080
  Debug: true

Database:
  Host: localhost
  Port: 5432
  Name: mydb

Read Configuration

using Apq.Cfg;
using Apq.Cfg.Yaml;

var cfg = new CfgBuilder()
    .AddYamlFile("config.yaml")  // Uses default level 0
    .Build();

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

Configuration Options

Parameter	Type	Default	Description
path	string	Required	File path
level	int	0	Priority level
writeable	bool	false	Enable write support
optional	bool	false	Allow missing file
reloadOnChange	bool	false	Enable hot reload

Next Steps

• JSON - JSON format
• Config Merge - Multi-source merging