AllConfig<Bag>The combined, yieldable-as-a-whole form of a config (like Config.all):
yield* allCfg resolves every field into one object. No per-field accessors —
make has those; pass either into the other to convert.
export interface interface AllConfig<Bag extends FieldRecord>The combined, yieldable-as-a-whole form of a config (like Config.all):
yield* allCfg resolves every field into one object. No per-field accessors —
make
has those; pass either into the other to convert.
AllConfig<function (type parameter) Bag in AllConfig<Bag extends FieldRecord>Bag extends type FieldRecord = {
[x: string]: ConfigField<unknown>
}
import EffectEffect.interface Effect<out A, out E = never, out R = never>The Effect interface defines a value that lazily describes a workflow or
job. The workflow requires some context R, and may fail with an error of
type E, or succeed with a value of type A.
When to use
Use when you need to represent a lazy, composable workflow that can require
services, fail with a typed error, or succeed with a typed value.
Details
Effect values model resourceful interaction with the outside world,
including synchronous, asynchronous, concurrent, and parallel interaction.
They use a fiber-based concurrency model, with built-in support for
scheduling, fine-grained interruption, structured concurrency, and high
scalability.
To run an Effect value, you need a Runtime, which is a type that is
capable of executing Effect values.
Effect<type BagShape<Bag extends FieldRecord> = {
readonly [K in keyof Bag]: Bag[K] extends ConfigField<
infer A
>
? A
: never
}
function (type parameter) Bag in AllConfig<Bag extends FieldRecord>Bag>, import ConfigConfig.class ConfigErrorclass ConfigError {
_tag: 'ConfigError';
name: string;
cause: SourceError | Schema.SchemaError;
message: string;
toString: () => string;
}
Represents the error type produced when config loading or validation fails.
When to use
Use when you need to inspect config loading or validation failures.
Details
Wraps either:
- A
SourceError — the provider could not read data (I/O failure).
- A
SchemaError — the data was found but did not match the schema
(wrong type, out of range, missing key, etc.).
ConfigError> {
readonly [const AllTypeId: typeof AllTypeIdAllTypeId]: function (type parameter) Bag in AllConfig<Bag extends FieldRecord>Bag;
}