Skip to content

Type Alias: ConfigItem<T>

ts
type ConfigItem<T> = object;

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

Base schema type for individual config items

Type Parameters

Type ParameterDefault type
Tunknown

Properties

PropertyTypeDescriptionDefined in
default?TDefault value used when no bind provides a value.packages/core/src/schema.ts:19
description?stringHuman-readable description used in generated docs and schema output.packages/core/src/schema.ts:21
example?TExample value shown in generated docs and schema output.packages/core/src/schema.ts:23
omitFromSchema?booleanExcludes this item from generated schema output when true.packages/core/src/schema.ts:27
sensitive?booleanMarks the value as sensitive for masking in logs and outputs.packages/core/src/schema.ts:25
validator?z.ZodType<T>Validation schema used to validate and optionally transform values.packages/core/src/schema.ts:29