Interface: LoadConfigOptions<S>

Defined in: packages/config/src/load.ts:34

Options for loadConfig.

Type Parameters

S

S extends TObject

Properties

defaults?

readonly optional defaults?: Layer<StaticType<[], "Encode", { }, { }, S>>

Defined in: packages/config/src/load.ts:42

Layer one: values in code. Typed, and may be partial. A default that is safe belongs here; a value with no safe default (where the database is, which environment this is) belongs nowhere, and its absence is fatal.

---

derive?

readonly optional derive?: (merged) => Layer<StaticType<[], "Encode", { }, { }, S>>

Defined in: packages/config/src/load.ts:48

Layer one, computed: receives everything merged from every layer, and returns values for keys that were left unset. It can never override a value an operator wrote; use it for a URL assembled from a host and a port.

Parameters

merged

Layer<StaticType<[], "Encode", { }, { }, S>>

Returns

Layer<StaticType<[], "Encode", { }, { }, S>>

---

env?

readonly optional env?: Readonly<Record<string, string | undefined>>

Defined in: packages/config/src/load.ts:58

The environment to read. Defaults to process.env; tests pass their own.

---

envPrefix

readonly envPrefix: string

Defined in: packages/config/src/load.ts:56

Layer three prefix. OKTOID reads OKTOID__DATABASE__POOL_SIZE as database.poolSize.

---

file?

readonly optional file?: string

Defined in: packages/config/src/load.ts:54

Layer two: the per-environment YAML file. When omitted, the variable <envPrefix>_CONFIG_FILE is consulted. A path that is given and missing is an error.

---

schema

readonly schema: S

Defined in: packages/config/src/load.ts:36

The schema from defineConfigSchema.

---

secretStore?

readonly optional secretStore?: SecretStore

Defined in: packages/config/src/load.ts:63

Replaces the driver named by secrets.driver, for tests and for adapters not yet in the registry. Its permitted classes are still enforced.