ConfigFile.ts overview
Since v2.0.0
Exports Grouped by Category
constructors
makeProvider
Signature
declare const makeProvider: (
fileName: string,
options?: { readonly formats?: ReadonlyArray<Kind>; readonly searchPaths?: ReadonlyArray<string> } | undefined
) => Effect<ConfigProvider, ConfigFileError, Path | FileSystem>
Since v2.0.0
errors
ConfigErrorTypeId
Signature
declare const ConfigErrorTypeId: unique symbol
Since v2.0.0
ConfigErrorTypeId (type alias)
Signature
type ConfigErrorTypeId = typeof ConfigErrorTypeId
Since v2.0.0
ConfigFileError
Signature
declare const ConfigFileError: (message: string) => ConfigFileError
Since v2.0.0
ConfigFileError (interface)
Signature
export interface ConfigFileError extends YieldableError {
readonly [ConfigErrorTypeId]: ConfigErrorTypeId
readonly _tag: "ConfigFileError"
readonly message: string
}
Since v2.0.0
layers
layer
Signature
declare const layer: (
fileName: string,
options?: { readonly formats?: ReadonlyArray<Kind>; readonly searchPaths?: ReadonlyArray<string> } | undefined
) => Layer<never, ConfigFileError, Path | FileSystem>
Since v2.0.0
models
Kind (type alias)
Signature
type Kind = "json" | "yaml" | "ini" | "toml"
Since v2.0.0