PlatformConfigProvider

6 exports Since v1.0.0 Source

Constructors

fromDotEnv

Since v1.0.0

Create a dotenv ConfigProvider.

Signature

declare const fromDotEnv: (paths: string) => Effect.Effect<ConfigProvider.ConfigProvider, PlatformError, FileSystem.FileSystem>

fromFileTree

Since v1.0.0

Signature

declare function fromFileTree(options?: {
  readonly rootDirectory?: string;
}): Effect<ConfigProvider, never, FileSystem | Path>

Layers

layerDotEnv

Since v1.0.0

Add the dotenv ConfigProvider to the environment, replacing the current ConfigProvider.

Signature

declare const layerDotEnv: (path: string) => Layer.Layer<never, PlatformError, FileSystem.FileSystem>

layerDotEnvAdd

Since v1.0.0

Add the dotenv ConfigProvider to the environment, as a fallback to the current ConfigProvider. If the file is not found, a debug log is produced and empty layer is returned.

Signature

declare const layerDotEnvAdd: (path: string) => Layer.Layer<never, never, FileSystem.FileSystem>

layerFileTree

Since v1.0.0

Add the file tree ConfigProvider to the environment, replacing the current ConfigProvider.

Signature

declare function layerFileTree(options?: {
  readonly rootDirectory?: string;
}): Layer<never, never, FileSystem | Path>

layerFileTreeAdd

Since v1.0.0

Add the file tree ConfigProvider to the environment, as a fallback to the current ConfigProvider.

Signature

declare function layerFileTreeAdd(options?: {
  readonly rootDirectory?: string;
}): Layer<never, never, FileSystem | Path>