Interface IConfigService<T>

ConfigService interface with dot notation support

interface IConfigService<T extends object = ModuleConfig> {
    all(): Readonly<T>;
    get<P extends string>(path: P): ConfigPathValue<T, P>;
    has(path: ConfigPath<T>): boolean;
    initialize(config: T): void;
    reset(path?: ConfigPath<T>): void;
    set<P extends string>(path: P, value: ConfigPathValue<T, P>): void;
}

Type Parameters

T extends object = ModuleConfig

Implemented by

ConfigService

Index

Methods

all get has initialize reset set

Methods

all

all(): Readonly<T>
Get entire config object

Returns Readonly<T>
- Defined in packages/core/src/config/config.types.ts:85

get

get<P extends string>(path: P): ConfigPathValue<T, P>
Get config value using dot notation
Type Parameters
- P extends string
Parameters
- path: P
Returns ConfigPathValue<T, P>
Example
```
config.get('database.url')
```
- Defined in packages/core/src/config/config.types.ts:68

has

has(path: ConfigPath<T>): boolean
Check if a config path exists
Parameters
- path: ConfigPath<T>
Returns boolean
- Defined in packages/core/src/config/config.types.ts:90

initialize

initialize(config: T): void
Initialize the config service with validated configuration Should be called once during application startup
Parameters
- config: T
Returns void
- Defined in packages/core/src/config/config.types.ts:62

reset

reset(path?: ConfigPath<T>): void
Reset config to original value
Parameters
- Optionalpath: ConfigPath<T>
  Optional path to reset (resets entire config if omitted)
Returns void
- Defined in packages/core/src/config/config.types.ts:80

set

set<P extends string>(path: P, value: ConfigPathValue<T, P>): void
Set config value at runtime (for runtime overrides)
Type Parameters
- P extends string
Parameters
- path: P
- value: ConfigPathValue<T, P>
Returns void
Example
```
config.set('email.from.name', 'Custom Name')
```
- Defined in packages/core/src/config/config.types.ts:74

Interface IConfigService<T>

Type Parameters

Implemented by

Index

Methods

Methods

all

Returns Readonly<T>

get

Type Parameters

Parameters

Returns ConfigPathValue<T, P>

Example

has

Parameters

Returns boolean

initialize

Parameters

Returns void

reset

Parameters

Returns void

set

Type Parameters

Parameters

Returns void

Example

Settings

On This Page