DotEnv overview

dotenv ConfigProvider

Added in v1.0.0

Table of contents

• constructors
  • makeConfigProvider
  • setConfigProvider
• errors
  • NoAvailableDotEnvFileError (interface)

constructors

makeConfigProvider

Create a dotenv config provider.

The input argument can be either a path to the .env file, list of .env files where order determine the preference, or it can be ommited in which case the default .env is used.

Signature

export declare const makeConfigProvider: (
  paths?: string | ReadonlyArray<string>
) => Effect.Effect<ConfigProvider.ConfigProvider, NoAvailableDotEnvFileError, FileSystem.FileSystem>

Added in v1.0.0

setConfigProvider

Create a layer that sets the ConfigProvider to dotenv config provider as a fallback to the current ConfigProvider.

The input argument can be either a path to the .env file, list of .env files where order determine the preference, or it can be ommited in which case the default .env is used.

The current config provider (process env by default) takes precendence over the dotenv provider.

Signature

export declare const setConfigProvider: (
  paths?: string | ReadonlyArray<string>
) => Layer.Layer<never, never, FileSystem.FileSystem>

Added in v1.0.0

errors

NoAvailableDotEnvFileError (interface)

Signature

export interface NoAvailableDotEnvFileError extends Cause.YieldableError {
  _tag: "NoAvailableDotEnvFileError"
  files: ReadonlyArray<string>
  error: unknown
}

Added in v1.0.0