Skip to main content Link Search Menu Expand Document (external link)

ConfigFile overview

Added in v2.0.0


Table of contents


constructors

makeProvider

Signature

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

Added in v2.0.0

errors

ConfigErrorTypeId

Signature

export declare const ConfigErrorTypeId: typeof ConfigErrorTypeId

Added in v2.0.0

ConfigErrorTypeId (type alias)

Signature

export type ConfigErrorTypeId = typeof ConfigErrorTypeId

Added in v2.0.0

ConfigFileError

Signature

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

Added in v2.0.0

ConfigFileError (interface)

Signature

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

Added in v2.0.0

layers

layer

Signature

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

Added in v2.0.0

models

Kind (type alias)

Signature

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

Added in v2.0.0