Skip to main content

Function: configFieldMeta()

function configFieldMeta<S>(schema, key): ConfigMeta;

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

One named field's metadata, for a host that has to read a single field on its own rather than the whole schema — the CLI asking whether a wallet identity was supplied before it decides which client to build.

key is checked against the schema, so a field renamed in the package that owns it fails to compile at the host that singles it out.

Type Parameters

Type Parameter
S extends ConfigSchema

Parameters

ParameterType
schemaS
keykeyof S["shape"] & string

Returns

ConfigMeta

Throws

when the field carries no metadata — see configFields.