Skip to main content

Type Alias: ConfigMeta

type ConfigMeta = object;

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

How one field of a layer config is named and documented in the places a string is all a host has: a --flag, an environment variable, a .env file, a secret manager.

Everything here is naming and presentation rather than validation, which is why it rides along as zod metadata (configMeta) instead of being a second record keyed the same way as the parsers: two structures with the same keys are exactly the drift this abstraction exists to remove.

Properties​

arg?​

optional arg?: string;

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

What the flag's value is called in --help, e.g. <url>. Cosmetic, and only read by a host that generates its own flags; defaults to <value>.

describe​

describe: string;

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

One line, for --help and for generated environment documentation.

env​

env: string;

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

This field's canonical environment-variable suffix, unprefixed — CORE_ADDRESS, not OVERCAST_CORE_ADDRESS or BASE_CORE_ADDRESS. Each host adds its own prefix (see envSource), which is what lets one schema serve a CLI with a single global namespace and a backend with one namespace per connected chain.

flag?​

optional flag?: string;

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

The CLI flag this field is exposed as, when it is one. Absent for a field only an environment reaches — and for a field no host should be typing by hand.

secret?​

optional secret?: boolean;

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

Key material and tokens. A secret field's value never appears in an error message; only its name does.

short?​

optional short?: string;

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

The short form of flag, e.g. -k. Rare on purpose — a single letter is a scarce, CLI-wide resource, and a config field is not entitled to one just because it exists.