Function: configEnum()

function configEnum<Values>(options): ConfigItem<Values[number]>;

Defined in: packages/core/src/schema.ts:140

Helper for creating type-safe enum/union config items. Automatically handles the Zod type for string enums.

Type Parameters

Type Parameter
Values extends readonly string[]

Parameters

Parameter	Type	Description
options	ConfigEnumOptions<Values>	Enum item configuration options.

Returns

ConfigItem<Values[number]>

A typed config item whose validator accepts only the provided enum values.

Example

const config = await ConfigBound.createConfig({
  environment: configEnum({
    values: ['development', 'staging', 'production'],
    default: 'development',
    description: 'Runtime environment'
  })
});