Interface: ElementOptions<T>
Defined in: packages/core/src/element/element.ts:18
Options for constructing an Element.
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
default? | T | The default value used when no bind provides a value. | packages/core/src/element/element.ts:24 |
description? | string | A human-readable description of what this element configures. | packages/core/src/element/element.ts:22 |
example? | T | An example value shown in exported schemas. Not validated. | packages/core/src/element/element.ts:26 |
logger? | Logger | Logger instance. Typically injected by the parent Section. | packages/core/src/element/element.ts:34 |
name | string | The name of the element. Must be unique within its section. | packages/core/src/element/element.ts:20 |
omitFromSchema? | boolean | When true, the element is excluded from exported schemas. | packages/core/src/element/element.ts:30 |
sensitive? | boolean | When true, the value is treated as sensitive (e.g. redacted in logs). | packages/core/src/element/element.ts:28 |
validator? | ZodType<T, unknown, $ZodTypeInternals<T, unknown>> | Zod validator applied to the resolved value. Defaults to z.any(). | packages/core/src/element/element.ts:32 |