konf

https://pkg.go.dev/github.com/nil-go/konf@v1.5.0
Admin
A minimal configuration loader for Go that decouples applications from configuration sources while...
Tokens:7,254
Snippets:98
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Config.Watch Method

Source: https://pkg.go.dev/github.com/nil-go/konf

Starts watching for configuration changes. This method blocks until the context is cancelled or an error occurs.

```APIDOC
## Watch

### Description
Watch starts watching for configuration changes. This method blocks until the context is cancelled or an error occurs.

### Signature
```go
func (c *Config) Watch(ctx context.Context) error
```
```

--------------------------------

### Register Loaders with SNS Notifier

Source: https://pkg.go.dev/github.com/nil-go/konf

Demonstrates how to use the SNS notifier to register configuration loaders and start watching for changes in cloud-based configuration sources like AppConfig and S3.

```go
notifier := sns.NewNotifier("konf-test")
notifier.Register(s3Loader, appConfigLoader)
go func() {
  if err := notifier.Start(ctx); err != nil {
    // handle error
  }
}()
```

--------------------------------

### Get Function

Source: https://pkg.go.dev/github.com/nil-go/konf

Retrieves the value under the given path from the default Config. It returns the zero value of the expected type if there is an error. The path is case-insensitive unless konf.WithCaseSensitive is set.

```APIDOC
## Get

### Description
Get retrieves the value under the given path from the default Config. It returns the zero value of the expected type if there is an error. The path is case-insensitive unless konf.WithCaseSensitive is set.

### Signature
```go
func Get[T any](path string) T
```

### Example
```go
// Assuming a configuration like: example.com
// value := konf.Get[string]("some.path")
// fmt.Println(value) // Output: example.com
```
```

--------------------------------

### Get Configuration Value with Konf

Source: https://pkg.go.dev/github.com/nil-go/konf

Retrieves a configuration value from the default Konf configuration using a path. Returns the zero value if an error occurs. Path is case-insensitive by default.

```go
func Get[T any](path string) T

```

```text
Output:
example.com

```

--------------------------------

### WithDelimiter Option Function

Source: https://pkg.go.dev/github.com/nil-go/konf

Sets the delimiter used for separating keys in configuration paths. For example, with the default '.', a path might be 'parent.child.key'.

```go
func WithDelimiter(delimiter string) Option
```

--------------------------------

### Option.WithDelimiter

Source: https://pkg.go.dev/github.com/nil-go/konf

WithDelimiter provides the delimiter used when specifying config paths. The delimiter is used to separate keys in the path. For example, with the default delimiter `.`, a config path might look like `parent.child.key`.

```APIDOC
## WithDelimiter

### Description
Provides the delimiter used when specifying config paths. The delimiter is used to separate keys in the path. For example, with the default delimiter `.`, a config path might look like `parent.child.key`.

### Signature
```go
func WithDelimiter(delimiter string) Option
```

### Parameters
#### Path Parameters
- **delimiter** (string) - The delimiter to use for config paths.
```

--------------------------------

### WithTagName Option Function

Source: https://pkg.go.dev/github.com/nil-go/konf

Sets the tag name used for reading field names when decoding configuration into structs. For example, with the default 'konf', it looks for 'konf' tags on struct fields.

```go
func WithTagName(tagName string) Option
```

--------------------------------

### Option.WithTagName

Source: https://pkg.go.dev/github.com/nil-go/konf

WithTagName provides the tag name that reads for field names. The tag name is used when decoding configuration into structs. For example, with the default tag name `konf`, it would look for `konf` tags on struct fields.

```APIDOC
## WithTagName

### Description
Provides the tag name that reads for field names. The tag name is used when decoding configuration into structs. For example, with the default tag name `konf`, it would look for `konf` tags on struct fields.

### Signature
```go
func WithTagName(tagName string) Option
```

### Parameters
#### Path Parameters
- **tagName** (string) - The tag name to use for struct field names.
```

--------------------------------

### Explain Configuration Loading Path

Source: https://pkg.go.dev/github.com/nil-go/konf

Use Config.Explain to understand how configuration values are resolved from different loaders for a given path. Sensitive information is automatically blurred.

```go
config.Explain("config.nest")

```

--------------------------------

### Load Configuration from Embed FS and Environment Variables

Source: https://pkg.go.dev/github.com/nil-go/konf

Demonstrates loading configuration from an embedded file system and environment variables early in an application's lifecycle. Handles potential loading errors.

```go
//go:embed config
var config embed.FS

func main() {
    var config konf.Config

    // Load configuration from embed file system.
    if err := config.Load(fs.New(config, "config/config.json")); err != nil {
        // Handle error here.
    }
    // Load configuration from environment variables.
    if err := config.Load(env.New(env.WithPrefix("server"))); err != nil {
        // Handle error here.
    }

    // Watch the changes of configuration.
    go func() {
      if err := config.Watch(ctx); err != nil {
        // Handle error here.
      }
    }()

    konf.SetDefault(config)

    // ... other setup code ...
}
```

--------------------------------

### Config.Explain Method

Source: https://pkg.go.dev/github.com/nil-go/konf

Provides information about how this Config instance resolves each value from loaders for the given path. It blurs sensitive information.

```APIDOC
## Explain

### Description
Explain provides information about how default Config resolve each value from loaders for the given path. It blur sensitive information. The path is case-insensitive unless konf.WithCaseSensitive is set.

### Signature
```go
func (c *Config) Explain(path string) string
```
```

--------------------------------

### Config.Explain

Source: https://pkg.go.dev/github.com/nil-go/konf

Explain provides information about how Config resolve each value from loaders for the given path. It blur sensitive information. The path is case-insensitive unless konf.WithCaseSensitive is set.

```APIDOC
## Config.Explain

### Description
Provides information about how Config resolves each value from loaders for the given path, blurring sensitive information. The path is case-insensitive unless konf.WithCaseSensitive is set.

### Signature
```go
func (c *Config) Explain(path string) string
```

### Parameters
#### Path Parameters
- **path** (string) - The configuration path to explain.
```

--------------------------------

### Read Server Configuration and Register Change Callbacks

Source: https://pkg.go.dev/github.com/nil-go/konf

Shows how to read server configuration with default values and register callbacks to handle configuration changes using konf.Unmarshal and konf.OnChange.

```go
func (app *appObject) Run() {
    // Server configuration with default values.
    serverConfig := struct {
        Host string
        Port int
    }{
        Host: "localhost",
        Port: "8080",
    }
    // Read the server configuration.
    if err := konf.Unmarshal("server", &serverConfig);  err != nil {
        // Handle error here.
    }

    // Register callbacks while server configuration changes.
    konf.OnChange(func() {
      // Reconfig the application object.
    }, "server")

    // ... use cfg in app code ...
}
```

--------------------------------

### Config.Explain Method Signature

Source: https://pkg.go.dev/github.com/nil-go/konf

Provides information about how Config resolves values from loaders for a given path. Sensitive information is blurred. Path case sensitivity depends on konf.WithCaseSensitive.

```go
func (c *Config) Explain(path string) string
```

--------------------------------

### Option.WithOnStatus

Source: https://pkg.go.dev/github.com/nil-go/konf

WithOnStatus provides the callback for monitoring status of configuration loading/watching.

```APIDOC
## WithOnStatus

### Description
Provides the callback for monitoring status of configuration loading/watching.

### Signature
```go
func WithOnStatus(onStatus func(loader Loader, changed bool, err error)) Option
```

### Parameters
#### Path Parameters
- **onStatus** (func(Loader, bool, error)) - The callback function to monitor status.
```

--------------------------------

### WithOnStatus Option Function

Source: https://pkg.go.dev/github.com/nil-go/konf

Provides a callback for monitoring the status of configuration loading and watching. Added in v0.8.0.

```go
func WithOnStatus(onStatus func(loader Loader, changed bool, err error)) Option
```

--------------------------------

### Config.Load Method Signature

Source: https://pkg.go.dev/github.com/nil-go/konf

Loads configuration from the given loader. Each loader takes precedence over preceding ones. This method is concurrent-safe.

```go
func (c *Config) Load(loader Loader) error
```

--------------------------------

### Explain Function

Source: https://pkg.go.dev/github.com/nil-go/konf

Provides information about how default Config resolves each value from loaders for the given path. It blurs sensitive information. The path is case-insensitive unless konf.WithCaseSensitive is set.

```APIDOC
## Explain

### Description
Provides information about how default Config resolve each value from loaders for the given path. It blur sensitive information. The path is case-insensitive unless konf.WithCaseSensitive is set.

### Signature
```go
func Explain(path string) string
```
```

--------------------------------

### Config.OnChange

Source: https://pkg.go.dev/github.com/nil-go/konf

OnChange registers a callback function that is executed when the value of any given path in the Config changes. It requires Config.Watch has been called first. The paths are case-insensitive unless konf.WithCaseSensitive is set. The register function must be non-blocking and usually completes instantly. If it requires a long time to complete, it should be executed in a separate goroutine. This method is concurrent-safe.

```APIDOC
## Config.OnChange

### Description
Registers a callback function that is executed when the value of any given path in the Config changes. It requires Config.Watch has been called first. The paths are case-insensitive unless konf.WithCaseSensitive is set. The register function must be non-blocking and usually completes instantly. If it requires a long time to complete, it should be executed in a separate goroutine. This method is concurrent-safe.

### Signature
```go
func (c *Config) OnChange(onChange func(*Config), paths ...string)
```

### Parameters
#### Path Parameters
- **onChange** (func(*Config)) - The callback function to execute when a change occurs.
- **paths** ([]string) - Optional. A variadic list of configuration paths to watch for changes.
```

--------------------------------

### Config.Watch Method Signature

Source: https://pkg.go.dev/github.com/nil-go/konf

Watches for and updates configuration changes. Blocks until the context is done or an error occurs. Can only be called once.

```go
func (c *Config) Watch(ctx context.Context) error
```

--------------------------------

### Config.OnChange Method Signature

Source: https://pkg.go.dev/github.com/nil-go/konf

Registers a callback function executed when a value at specified paths changes. Requires Config.Watch to be called first. Paths are case-insensitive unless konf.WithCaseSensitive is set. The callback must be non-blocking.

```go
func (c *Config) OnChange(onChange func(*Config), paths ...string)
```

--------------------------------

### Config.Load Method

Source: https://pkg.go.dev/github.com/nil-go/konf

Loads configuration from the given Loader into this Config instance.

```APIDOC
## Load

### Description
Load reads configuration from the given Loader into this Config instance.

### Signature
```go
func (c *Config) Load(loader Loader) error
```
```

--------------------------------

### WithLogHandler Option Function

Source: https://pkg.go.dev/github.com/nil-go/konf

Provides a slog.Handler for logs generated during configuration watching. Defaults to slog.Default().

```go
func WithLogHandler(handler slog.Handler) Option
```

--------------------------------

### Loader.Load

Source: https://pkg.go.dev/github.com/nil-go/konf

Load loads the latest configuration and returns it as a nested map[string]any. The keys should be nested like {parent: {child: {key: 1}}}.

```APIDOC
## Loader.Load

### Description
Loads the latest configuration and returns it as a nested map[string]any. The keys should be nested like `{parent: {child: {key: 1}}}`.

### Signature
```go
func (l Loader) Load() (map[string]any, error)
```

### Returns
- **map[string]any** - The loaded configuration as a nested map.
- **error** - An error if the configuration could not be loaded.
```

--------------------------------

### Config.New Function

Source: https://pkg.go.dev/github.com/nil-go/konf

Creates a new Config with the given Option(s).

```APIDOC
## New

### Description
New creates a new Config with the given Option(s).

### Signature
```go
func New(opts ...Option) *Config
```
```

--------------------------------

### Load Configuration with Cobra Flags

Source: https://pkg.go.dev/github.com/nil-go/konf

Integrate Konf with Cobra commands by using the pflag loader and providing a custom flag set.

```go
config.Load(kflag.New(&config, kflag.WithFlagSet(yourCobraCmd.Flags())))

```

--------------------------------

### Config.OnChange Method

Source: https://pkg.go.dev/github.com/nil-go/konf

Registers a callback function that is executed when the value of any given path in this Config instance changes. The paths are case-insensitive unless konf.WithCaseSensitive is set.

```APIDOC
## OnChange

### Description
OnChange registers a callback function that is executed when the value of any given path in this Config instance changes. The paths are case-insensitive unless konf.WithCaseSensitive is set.

The register function must be non-blocking and usually completes instantly. If it requires a long time to complete, it should be executed in a separate goroutine.
This method is concurrent-safe.

### Signature
```go
func (c *Config) OnChange(onChange func(*Config), paths ...string)
```
```

--------------------------------

### Config.Unmarshal Method Signature

Source: https://pkg.go.dev/github.com/nil-go/konf

Reads configuration under a given path and decodes it into the target object. Path case sensitivity depends on konf.WithCaseSensitive.

```go
func (c *Config) Unmarshal(path string, target any) error
```

--------------------------------

### Option Type Definition

Source: https://pkg.go.dev/github.com/nil-go/konf

Type for configuration options, used to customize Config behavior.

```go
type Option func(*options)
```

--------------------------------

### Config Type

Source: https://pkg.go.dev/github.com/nil-go/konf

Represents a configuration object that reads configuration from appropriate sources. Use New to create a new Config instance.

```APIDOC
## Config Type

### Description
Config reads configuration from appropriate sources.
To create a new Config, call New.

### Definition
```go
type Config struct {
	// contains filtered or unexported fields
}
```
```

--------------------------------

### Config.Load

Source: https://pkg.go.dev/github.com/nil-go/konf

Load loads configuration from the given loader. Each loader takes precedence over the loaders before it. This method is concurrent-safe.

```APIDOC
## Config.Load

### Description
Loads configuration from the given loader. Each loader takes precedence over the loaders before it. This method is concurrent-safe.

### Signature
```go
func (c *Config) Load(loader Loader) error
```

### Parameters
#### Path Parameters
- **loader** (Loader) - The loader to load configuration from.
```

--------------------------------

### Config.Exists Method

Source: https://pkg.go.dev/github.com/nil-go/konf

Tests if the given path exists in the configuration. It's used by the loader to check if the configuration has been set by other loaders.

```APIDOC
## Exists

### Description
Exists tests if the given path exist in the configuration. It's used by the loader to check if the configuration has been set by other loaders.

### Signature
```go
func (c *Config) Exists(path []string) bool
```
```

--------------------------------

### Config.Watch

Source: https://pkg.go.dev/github.com/nil-go/konf

Watch watches and updates configuration when it changes. It blocks until ctx is done, or the service returns an error. It only can be called once. Call after first has no effects.

```APIDOC
## Config.Watch

### Description
Watches and updates configuration when it changes. It blocks until ctx is done, or the service returns an error. It can only be called once; subsequent calls have no effect.

### Signature
```go
func (c *Config) Watch(ctx context.Context) error
```

### Parameters
#### Path Parameters
- **ctx** (context.Context) - The context to control the watching process.
```

--------------------------------

### Watcher.Watch

Source: https://pkg.go.dev/github.com/nil-go/konf

Watch watches the configuration and triggers the register callback with the latest full configurations as a nested map[string]any when it changes. It blocks until ctx is done, or the watching returns an error.

```APIDOC
## Watcher.Watch

### Description
Watches the configuration and triggers the register callback with the latest full configurations as a nested map[string]any when it changes. It blocks until ctx is done, or the watching returns an error.

### Signature
```go
func (w Watcher) Watch(ctx context.Context, onChange func(map[string]any)) error
```

### Parameters
#### Path Parameters
- **ctx** (context.Context) - The context to control the watching process.
- **onChange** (func(map[string]any)) - The callback function to execute when configuration changes.
```

--------------------------------

### Statuser.Status

Source: https://pkg.go.dev/github.com/nil-go/konf

Status enables providers report the status of configuration watching.

```APIDOC
## Statuser.Status

### Description
Enables providers to report the status of configuration watching.

### Signature
```go
func (s Statuser) Status(onStatus func(changed bool, err error))
```

### Parameters
#### Path Parameters
- **onStatus** (func(bool, error)) - The callback function to report status.
```

--------------------------------

### Option.WithCaseSensitive

Source: https://pkg.go.dev/github.com/nil-go/konf

WithCaseSensitive enables the case sensitivity of the configuration keys.

```APIDOC
## WithCaseSensitive

### Description
Enables the case sensitivity of the configuration keys.

### Signature
```go
func WithCaseSensitive() Option
```

### Returns
- **Option** - An Option to configure case sensitivity.
```

--------------------------------

### Embedded Structs vs. Squashed Structs in Konf

Source: https://pkg.go.dev/github.com/nil-go/konf

Demonstrates how Konf handles embedded structs by default and how to use the 'squash' tag to flatten them. Use 'squash' when the embedded struct fields should be directly accessible.

```go
type Person struct {
    Name string
}

type Friend struct {
    Person
}

type Friend struct {
    Person Person
}

```

```go
map[string]interface{}{
    "person": map[string]interface{}{"name": "alice"},
}

```

```go
type Friend struct {
    Person `konf:",squash"`
}

```

```go
map[string]interface{}{
    "name": "alice",
}

```

--------------------------------

### OnChange Function

Source: https://pkg.go.dev/github.com/nil-go/konf

Registers a callback function that is executed when the value of any given path in the default Config changes. The paths are case-insensitive unless konf.WithCaseSensitive is set.

```APIDOC
## OnChange

### Description
OnChange registers a callback function that is executed when the value of any given path in the default Config changes. The paths are case-insensitive unless konf.WithCaseSensitive is set.

The register function must be non-blocking and usually completes instantly. If it requires a long time to complete, it should be executed in a separate goroutine.
This method is concurrent-safe.

### Signature
```go
func OnChange(onChange func(), paths ...string)
```
```

--------------------------------

### Config.Unmarshal Method

Source: https://pkg.go.dev/github.com/nil-go/konf

Reads configuration under the given path from this Config instance and decodes it into the given object pointed to by target. The path is case-insensitive unless konf.WithCaseSensitive is set.

```APIDOC
## Unmarshal

### Description
Unmarshal reads configuration under the given path from this Config instance and decodes it into the given object pointed to by target. The path is case-insensitive unless konf.WithCaseSensitive is set.

### Signature
```go
func (c *Config) Unmarshal(path string, target any) error
```
```

--------------------------------

### Unmarshal Configuration with Konf

Source: https://pkg.go.dev/github.com/nil-go/konf

Reads configuration from the default Konf instance under a given path and decodes it into a target struct. Path is case-insensitive by default.

```go
func Unmarshal(path string, target any) error

```

```text
Output:
example.com:8080

```

--------------------------------

### Loader Interface Definition

Source: https://pkg.go.dev/github.com/nil-go/konf

Interface for loading configuration. The Load method returns configuration as a nested map[string]any, with keys nested like {parent: {child: {key: 1}}}.

```go
type Loader interface {
	Load() (map[string]any, error)
}
```

--------------------------------

### Set Default Konf Configuration

Source: https://pkg.go.dev/github.com/nil-go/konf

Sets a specific Config instance as the default for the Konf package. Subsequent calls to top-level Konf functions will use this default configuration.

```go
func SetDefault(config *Config)

```

```text
Output:


```

--------------------------------

### WithMapKeyCaseSensitive Option Function

Source: https://pkg.go.dev/github.com/nil-go/konf

Enables case sensitivity for map keys within configuration. Added in v1.2.0.

```go
func WithMapKeyCaseSensitive() Option
```

--------------------------------

### Option.WithLogHandler

Source: https://pkg.go.dev/github.com/nil-go/konf

WithLogHandler provides the slog.Handler for logs from watch. By default, it uses handler from slog.Default().

```APIDOC
## WithLogHandler

### Description
Provides the slog.Handler for logs from watch. By default, it uses handler from slog.Default().

### Signature
```go
func WithLogHandler(handler slog.Handler) Option
```

### Parameters
#### Path Parameters
- **handler** (slog.Handler) - The slog.Handler to use for logs.
```

--------------------------------

### WithCaseSensitive Option Function

Source: https://pkg.go.dev/github.com/nil-go/konf

Enables case sensitivity for configuration keys. Added in v0.9.0.

```go
func WithCaseSensitive() Option
```

--------------------------------

### Option.WithMapKeyCaseSensitive

Source: https://pkg.go.dev/github.com/nil-go/konf

WithMapKeyCaseSensitive enables the case sensitivity of the map keys.

```APIDOC
## WithMapKeyCaseSensitive

### Description
Enables the case sensitivity of the map keys.

### Signature
```go
func WithMapKeyCaseSensitive() Option
```

### Returns
- **Option** - An Option to configure map key case sensitivity.
```

--------------------------------

### WithDecodeHook Option Function

Source: https://pkg.go.dev/github.com/nil-go/konf

Provides a decode hook to customize configuration decoding. Supports functions like `func(F) (T, error)` or `func(F, T) error`. Defaults include string to time.Duration, string to []string (split by `,`), and string to encoding.TextUnmarshaler.

```go
func WithDecodeHook[F, T any, FN func(F) (T, error) | func(F, T) error](hook FN) Option
```

--------------------------------

### Statuser Interface Definition

Source: https://pkg.go.dev/github.com/nil-go/konf

Interface for providers to report the status of configuration watching. The Status method takes a callback function. Added in v0.8.0.

```go
type Statuser interface {
	Status(onStatus func(changed bool, err error))
}
```

--------------------------------

### Unmarshal Function

Source: https://pkg.go.dev/github.com/nil-go/konf

Reads configuration under the given path from the default Config and decodes it into the given object pointed to by target. The path is case-insensitive unless konf.WithCaseSensitive is set.

```APIDOC
## Unmarshal

### Description
Unmarshal reads configuration under the given path from the default Config and decodes it into the given object pointed to by target. The path is case-insensitive unless konf.WithCaseSensitive is set.

### Signature
```go
func Unmarshal(path string, target any) error
```

### Example
```go
// Assuming a configuration like: example.com:8080
// var host string
// var port int
// err := konf.Unmarshal("network", &struct { Host string `konf:"host"`; Port int `konf:"port"` }{}) 
// fmt.Printf("%s:%d\n", host, port) // Output: example.com:8080
```
```

--------------------------------

### Watcher Interface Definition

Source: https://pkg.go.dev/github.com/nil-go/konf

Interface for watching configuration changes. The Watch method triggers a callback with the latest configuration when changes occur. It blocks until the context is done or an error is returned.

```go
type Watcher interface {
	Watch(ctx context.Context, onChange func(map[string]any)) error
}
```

--------------------------------

### Config.Unmarshal

Source: https://pkg.go.dev/github.com/nil-go/konf

Unmarshal reads configuration under the given path from the Config and decodes it into the given object pointed to by target. The path is case-insensitive unless konf.WithCaseSensitive is set.

```APIDOC
## Config.Unmarshal

### Description
Reads configuration under the given path from the Config and decodes it into the given object pointed to by target. The path is case-insensitive unless konf.WithCaseSensitive is set.

### Signature
```go
func (c *Config) Unmarshal(path string, target any) error
```

### Parameters
#### Path Parameters
- **path** (string) - The configuration path to unmarshal.
- **target** (any) - A pointer to the object to decode the configuration into.
```

--------------------------------

### SetDefault Function

Source: https://pkg.go.dev/github.com/nil-go/konf

Sets the given Config as the default Config. After this call, the konf package's top functions (e.g. konf.Get) will interact with the given Config.

```APIDOC
## SetDefault

### Description
SetDefault sets the given Config as the default Config. After this call, the konf package's top functions (e.g. konf.Get) will interact with the given Config.

### Signature
```go
func SetDefault(config *Config)
```
```

--------------------------------

### Option.WithDecodeHook

Source: https://pkg.go.dev/github.com/nil-go/konf

WithDecodeHook provides the decode hook for decoding. The decode hook is a function that can customize how configuration are decoded. It can be either `func(F) (T, error)` which returns the converted value, or `func(F, T) error` which sets the converted value inline. By default, it composes string to time.Duration, string to []string split by `,` and string to encoding.TextUnmarshaler.

```APIDOC
## WithDecodeHook

### Description
Provides the decode hook for decoding. The decode hook is a function that can customize how configuration are decoded. It can be either `func(F) (T, error)` which returns the converted value, or `func(F, T) error` which sets the converted value inline. By default, it composes string to time.Duration, string to []string split by `,` and string to encoding.TextUnmarshaler.

### Signature
```go
func WithDecodeHook[F, T any, FN func(F) (T, error) | func(F, T) error](hook FN) Option
```

### Parameters
#### Path Parameters
- **hook** (FN) - The decode hook function.
```

--------------------------------

### Rename Struct Fields with 'konf' Tag

Source: https://pkg.go.dev/github.com/nil-go/konf

Customize the configuration key name for a struct field by using the 'konf' struct tag.

```go
type User struct {
    Username string `konf:"user"`
}

```

--------------------------------

### Struct Field Mapping with Default Naming

Source: https://pkg.go.dev/github.com/nil-go/konf

Konf maps struct fields to configuration keys using the field name by default, ignoring case.

```go
type User struct {
    Username string
}

```

--------------------------------

### Handling Unexported Fields in Konf

Source: https://pkg.go.dev/github.com/nil-go/konf

Illustrates that Konf skips unexported struct fields during decoding because they cannot be set outside their package. The unexported field will retain its zero value.

```go
type Exported struct {
    private string // this unexported field will be skipped
    Public string
}

```

```go
map[string]interface{}{
    "private": "I will be ignored",
    "Public":  "I made it through!",
}

```

```go
type Exported struct {
    private: "" // field is left with an empty string (zero value)
    Public: "I made it through!"
}

```
Tokens:
Raw