Function: configEnum()

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

Defined in: packages/config-bound/src/configBound.ts:129

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
options	{ default?: Values[number]; description?: string; example?: Values[number]; sensitive?: boolean; values: Values; }
options.default?	Values[number]
options.description?	string
options.example?	Values[number]
options.sensitive?	boolean
options.values	Values

Returns

ConfigItem<Values[number]>

Example

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