Skip to main content

Interface: ConfigSource

Defined in: packages/overcast-core/src/config-schema.ts:258

Where a host's values come from, and what it calls them when one is wrong.

The whole host-specific half of reading a config, which is why it is two functions and not a Record<string, string>: the naming is not cosmetic. A user who typed --chain-id must be told about --chain-id, and an operator who set BASE_CHAIN_ID about BASE_CHAIN_ID, or the error names a key that exists nowhere in what they wrote.

Methods

name()

name(meta): string;

Defined in: packages/overcast-core/src/config-schema.ts:262

How this host names it — --chain-id, BASE_CHAIN_ID.

Parameters

ParameterType
metaConfigMeta

Returns

string


read()

read(meta): string | undefined;

Defined in: packages/overcast-core/src/config-schema.ts:260

The raw, un-normalized value for the field meta describes, or undefined when unset.

Parameters

ParameterType
metaConfigMeta

Returns

string | undefined