ConfigManager

Defined in: packages/engine/src/constants/Configuration.ts:351

Configuration manager for engine settings

Example

const configManager = new ConfigManager();
configManager.set('performance.defaultCacheSize', 2000);
const cacheSize = configManager.get('performance.defaultCacheSize');

Constructors

Constructor

new ConfigManager(config?): ConfigManager;

Defined in: packages/engine/src/constants/Configuration.ts:354

Parameters

Parameter	Type
config	Partial<EngineConfig>

Returns

ConfigManager

Methods

get()

get<T>(path): T;

Defined in: packages/engine/src/constants/Configuration.ts:364

Get configuration value by path

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
path	string	Dot-notation path to config value

Returns

T

Configuration value

---

getConfig()

getConfig(): EngineConfig;

Defined in: packages/engine/src/constants/Configuration.ts:430

Get complete configuration.

A detached copy, section objects included. A top-level spread would hand the caller this manager’s own section objects, so getConfig().vm.x = 1 would be an undeclared back door into set, bypassing its path validation and reaching every later get.

Returns

EngineConfig

---

reset()

reset(): void;

Defined in: packages/engine/src/constants/Configuration.ts:453

Reset to default configuration.

Goes through mergeEngineConfig for the same reason the constructor does. A top-level { ...DEFAULT_CONFIG } copies the six section references, not the sections, so after a reset this manager’s performance object WAS DEFAULT_CONFIG.performance and the next set('performance.x', ...) wrote into the module constant. That constant is what every ExpressionEngine is built from, so one manager’s reset could change the cache size, instruction ceiling or allocation budget of every engine constructed later in the process.

Returns

void

---

set()

set<T>(path, value): void;

Defined in: packages/engine/src/constants/Configuration.ts:389

Set configuration value by path

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
path	string	Dot-notation path to config value
value	T	New value

Returns

void

---

update()

update(config): void;

Defined in: packages/engine/src/constants/Configuration.ts:437

Update multiple configuration values

Parameters

Parameter	Type
config	Partial<EngineConfig>

Returns

void

---

validate()

validate(): ValidationResult;

Defined in: packages/engine/src/constants/Configuration.ts:460

Validate configuration values

Returns

ValidationResult