Class: Element<T>

Defined in: packages/core/src/element/element.ts:40

A Element is a single configuration option

Type Parameters

Type Parameter
T

Constructors

Constructor

new Element<T>(options): Element<T>;

Defined in: packages/core/src/element/element.ts:78

Parameters

Parameter	Type
options	ElementOptions<T>

Returns

Element<T>

Properties

Property	Modifier	Type	Description	Defined in
default?	public	T	The default value of the Element	packages/core/src/element/element.ts:56
description?	public	string	An optional description of the Element	packages/core/src/element/element.ts:52
example?	public	T	An example value of the Element	packages/core/src/element/element.ts:60
name	readonly	string	The name of the Element	packages/core/src/element/element.ts:44
omitFromSchema	public	boolean	Whether to omit the Element from the exported schema	packages/core/src/element/element.ts:64
sensitive	public	boolean	Whether the Element is sensitive	packages/core/src/element/element.ts:48
validator	public	ZodType<T>	The Zod validator of the Element	packages/core/src/element/element.ts:68

Methods

get()

get<R>(valueProvider): Promise<R | undefined>;

Defined in: packages/core/src/element/element.ts:141

Retrieves the value of the element

Type Parameters

Type Parameter
R

Parameters

Parameter	Type	Description
valueProvider	ConfigValueProvider	The provider to use for retrieving values

Returns

Promise<R | undefined>

the value of the Element. If it's unset, then it returns undefined.

---

getOrThrow()

getOrThrow<R>(valueProvider): Promise<R>;

Defined in: packages/core/src/element/element.ts:164

Retrieves the value of the element or throws an error if the value isn't found.

Type Parameters

Type Parameter
R

Parameters

Parameter	Type	Description
valueProvider	ConfigValueProvider	The provider to use for retrieving values

Returns

Promise<R>

the value of the Element.

Throws

ConfigUnsetException if the value has not been set

---

isRequired()

isRequired(): boolean;

Defined in: packages/core/src/element/element.ts:132

Returns true if the Element is required.

Returns

boolean

true when no default value exists and the validator is not optional.

---

setLogger()

setLogger(logger): void;

Defined in: packages/core/src/element/element.ts:123

Sets the logger instance

Parameters

Parameter	Type	Description
logger	Logger	The logger to use

Returns

void

---

setParentSection()

setParentSection(sectionName): void;

Defined in: packages/core/src/element/element.ts:115

Sets the parent section name.

Parameters

Parameter	Type	Description
sectionName	string	Name of the section this element belongs to.

Returns

void