Skip to content

[Docs] Fix up docs around key mapping #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 6, 2025
Merged

[Docs] Fix up docs around key mapping #46

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion Sources/Configuration/Providers/Wrappers/KeyMappingProvider.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
///
/// ## Example
///
/// Use `MappedKeyProvider` when you want to map keys for specific providers in a multi-provider
/// Use `KeyMappingProvider` when you want to map keys for specific providers in a multi-provider
/// setup:
///
/// ```swift
Expand All @@ -49,6 +49,18 @@
/// // This reads from "MYAPP_PROD_DATABASE_HOST" env var or "database.host" in JSON
/// let host = config.string(forKey: "database.host", default: "localhost")
/// ```
///
/// ## Convenience method
///
/// You can also use the ``ConfigProvider/prefixKeys(with:)`` convenience method on
/// configuration provider types to wrap one in a ``KeyMappingProvider``:
///
/// ```swift
/// let envProvider = EnvironmentVariablesProvider()
/// let keyMappedEnvProvider = envProvider.mapKeys { key in
/// key.prepending(["myapp", "prod"])
/// }
/// ```
public struct KeyMappingProvider<Upstream: ConfigProvider>: Sendable {
/// The mapping function applied to each key before a lookup.
private let mapKey: @Sendable (AbsoluteConfigKey) -> AbsoluteConfigKey
Expand Down
Loading