effect-io-ai

Package: effect
Module: Config

Config.string

Creates a config for a single string value.

When to use

Use when reading a single string env var or config key.

Details

Shortcut for Config.schema(Schema.String, name).

Example (Reading a string config)

import { Config, ConfigProvider, Effect } from "effect"

const host = Config.string("HOST")

const provider = ConfigProvider.fromUnknown({ HOST: "localhost" })
// Effect.runSync(host.parse(provider)) // "localhost"

See

• nonEmptyString – rejects empty strings
• schema – for more complex types

Signature

declare const string: (name?: string) => Config<string>

Source

Since v2.0.0