Skip to content
Effect Days 2026 Get your ticket

ConfigFile

7 exports Added in v2.0.0 Source

Constructors

makeProvider

Added in v2.0.0 Source

fileName must be a static application-defined value and must not be derived from untrusted input.

Signature

declare const makeProvider: (fileName: string, options?: {
readonly formats?: ReadonlyArray<Kind>;
readonly searchPaths?: ReadonlyArray<string>;
}) => Effect<ConfigProvider, ConfigFileError, Path | FileSystem>

Errors

Signature

declare const ConfigErrorTypeId: unique symbol

ConfigErrorTypeId type

Added in v2.0.0 Source

Signature

type ConfigErrorTypeId = typeof ConfigErrorTypeId

Signature

declare const ConfigFileError: (message: string) => ConfigFileError

ConfigFileError interface

Added in v2.0.0 Source

Signature

interface ConfigFileError extends YieldableError {
readonly _tag: "ConfigFileError";
readonly [ConfigErrorTypeId]: typeof ConfigErrorTypeId;
readonly message: string;
}

Layers

layer

Added in v2.0.0 Source

fileName must be a static application-defined value and must not be derived from untrusted input.

Signature

declare const layer: (fileName: string, options?: {
readonly formats?: ReadonlyArray<Kind>;
readonly searchPaths?: ReadonlyArray<string>;
}) => Layer<never, ConfigFileError, Path | FileSystem>

Models

Kind type

Added in v2.0.0 Source

Signature

type Kind = "json" | "yaml" | "ini" | "toml"