Class Config<T>

Type Parameters

T extends ConfigSchema = ConfigSchema

Index

Constructors

Methods

create fromEnv get getAs getByPath getOrDefault getValidationErrors has isValid keys merge toObject

Constructors

constructor

new Config<T extends ConfigSchema = ConfigSchema>(
data: T,
validationRules?: ConfigValidationRule[],
): Config<T>
Type Parameters
- T extends ConfigSchema = ConfigSchema
Parameters
- data: T
- OptionalvalidationRules: ConfigValidationRule[]
Returns Config<T>
- Defined in kernel/dist/config.d.ts:35

Methods

`Static`create

create<T extends ConfigSchema>(
data: T,
rules?: ConfigValidationRule[],
): Config<T>
Create Config with validation, throw on invalid
Type Parameters
- T extends ConfigSchema
Parameters
- data: T
- Optionalrules: ConfigValidationRule[]
Returns Config<T>
- Defined in kernel/dist/config.d.ts:87

`Static`fromEnv

fromEnv<T extends ConfigSchema>(prefix: string, schema: T): Config<T>
Create a new Config from environment variables
Type Parameters
- T extends ConfigSchema
Parameters
- prefix: string
- schema: T
Returns Config<T>
- Defined in kernel/dist/config.d.ts:75

get

get<K extends string | number | symbol>(key: K): T[K]
Get a configuration value by key
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
Returns T[K]
- Defined in kernel/dist/config.d.ts:39

getAs

getAs<K extends string | number | symbol, R>(key: K): R
Get a configuration value with type assertion
Type Parameters
- K extends string | number | symbol
- R
Parameters
- key: K
Returns R
- Defined in kernel/dist/config.d.ts:43

getByPath

getByPath(path: string): ConfigValue | undefined
Get a nested configuration value by dot-separated path
Parameters
- path: string
Returns ConfigValue | undefined
- Defined in kernel/dist/config.d.ts:47

getOrDefault

getOrDefault<K extends string | number | symbol>(
key: K,
defaultValue: T[K],
): T[K]
Get a nested configuration value with default
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
- defaultValue: T[K]
Returns T[K]
- Defined in kernel/dist/config.d.ts:51

getValidationErrors

getValidationErrors(): string[]
Get validation errors

Returns string[]
- Defined in kernel/dist/config.d.ts:71

has

has(key: string): boolean
Check if a key exists
Parameters
- key: string
Returns boolean
- Defined in kernel/dist/config.d.ts:63

isValid

isValid(): boolean
Check if validation passed

Returns boolean
- Defined in kernel/dist/config.d.ts:67

keys

keys(): string[]
Get all configuration keys

Returns string[]
- Defined in kernel/dist/config.d.ts:55

merge

merge<U extends ConfigSchema>(other: Config<U>): Config<T & U>
Merge two configurations (second overrides first)
Type Parameters
- U extends ConfigSchema
Parameters
- other: Config<U>
Returns Config<T & U>
- Defined in kernel/dist/config.d.ts:79

toObject

toObject(): Readonly<T>
Get the full configuration data

Returns Readonly<T>
- Defined in kernel/dist/config.d.ts:59