Skip to main content

Function: configChoices()

function configChoices(field): readonly string[] | undefined;

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

The values field accepts, when it accepts a closed set of them — so a host that generates flags can offer --transport polling|websocket rather than letting the parser reject it afterwards.

Unwraps the shapes a closed set actually arrives in: the .optional() configField adds, and a .transform() that turns the chosen value into whatever the config field holds (--transport websocket reaches socketConfig as { transports: ["websocket"] }). undefined for every other field, which is most of them.

Parameters

ParameterType
field$ZodType

Returns

readonly string[] | undefined