Skip to content

Interface: ConfigEnumOptions<Values>

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

Options for creating a string enum/union configuration item.

Type Parameters

Type Parameter
Values extends readonly string[]

Properties

PropertyTypeDescriptionDefined in
default?Values[number]Default value used when no bind provides a value.packages/core/src/schema.ts:60
description?stringHuman-readable description used in generated docs and schema output.packages/core/src/schema.ts:62
example?Values[number]Example value shown in generated docs and schema output.packages/core/src/schema.ts:64
sensitive?booleanMarks the value as sensitive for masking in logs and outputs.packages/core/src/schema.ts:66
valuesValuesAllowed string values for the enum/union item.packages/core/src/schema.ts:58