Class: Element<T>

Defined in: packages/config-bound/src/element/element.ts:18

A Element is a single configuration option

Type Parameters

Type Parameter
T

Constructors

Constructor

new Element<T>(
   name, 
   description?, 
   defaultValue?, 
   exampleValue?, 
   sensitive?, 
   omitFromSchema?, 
   validator?, 
logger?): Element<T>;

Defined in: packages/config-bound/src/element/element.ts:56

Parameters

Parameter	Type	Default value
name	string	undefined
description?	string	undefined
defaultValue?	T	undefined
exampleValue?	T	undefined
sensitive?	boolean	false
omitFromSchema?	boolean	false
validator?	ZodType<T>	...
logger?	Logger	undefined

Returns

Element<T>

Properties

Property	Modifier	Type	Description	Defined in
default?	public	T	The default value of the Element	packages/config-bound/src/element/element.ts:34
description?	public	string	An optional description of the Element	packages/config-bound/src/element/element.ts:30
example?	public	T	An example value of the Element	packages/config-bound/src/element/element.ts:38
name	readonly	string	The name of the Element	packages/config-bound/src/element/element.ts:22
omitFromSchema	public	boolean	Whether to omit the Element from the exported schema	packages/config-bound/src/element/element.ts:42
sensitive	public	boolean	Whether the Element is sensitive	packages/config-bound/src/element/element.ts:26
validator	public	ZodType<T>	The Zod validator of the Element	packages/config-bound/src/element/element.ts:46

Methods

get()

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

Defined in: packages/config-bound/src/element/element.ts:116

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/config-bound/src/element/element.ts:139

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/config-bound/src/element/element.ts:107

Returns true if the Element is required

Returns

boolean

---

setLogger()

setLogger(logger): void;

Defined in: packages/config-bound/src/element/element.ts:100

Sets the logger instance

Parameters

Parameter	Type	Description
logger	Logger	The logger to use

Returns

void

---

setParentSection()

setParentSection(sectionName): void;

Defined in: packages/config-bound/src/element/element.ts:92

Sets the parent section name

Parameters

Parameter	Type
sectionName	string

Returns

void