Skip to content

Function: configItem()

ts
function configItem<T>(options): ConfigItem<T>;

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

Creates a type-safe configuration item. This helper provides better type inference and makes the schema more readable.

Type Parameters

Type Parameter
T

Parameters

ParameterType
optionsConfigItem<T>

Returns

ConfigItem<T>

Example

typescript
const config = await ConfigBound.createConfig({
  port: configItem<number>({
    default: 3000,
    validator: z.number().int().min(0).max(65535),
    description: 'Server port',
    example: 8080
  })
});