Skip to content

Function: configSection()

ts
function configSection<T>(properties, description?): ConfigSection<T>;

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

Creates a configuration section with multiple related items. Sections help organize configuration into logical groups.

Type Parameters

Type Parameter
T extends Record<string, unknown>

Parameters

ParameterTypeDescription
properties{ [K in string | number | symbol]: ConfigItem<T[K]> }Section item definitions keyed by item name.
description?stringOptional human-readable description for the section.

Returns

ConfigSection<T>

A typed section definition ready for createConfig.

Example

typescript
const config = await ConfigBound.createConfig({
  database: configSection({
    host: configItem<string>({ default: 'localhost', validator: z.string() }),
    port: configItem<number>({ default: 5432, validator: z.number() })
  }, 'Database configuration')
});