Class Kfg<D, S>

Type Parameters

D extends KfgDriver<any, any>
S extends SchemaDefinition

Index

Constructors

Properties

~cache ~driver ~loaded ~schema config

Accessors

Methods

conf del get has inject insert load reload root save schematic set toJSON

Constructors

constructor

new Kfg<D extends KfgDriver<any, any>, S extends SchemaDefinition>(
driver: D,
schema: S,
): Kfg<D, S>
Type Parameters
- D extends KfgDriver<any, any>
- S extends SchemaDefinition
Parameters
- driver: D
- schema: S
Returns Kfg<D, S>
- Defined in src/kfg.ts:36

Properties

~cache

"~cache": Record<string, any> = {}

`Readonly`~driver

"~driver": D

~loaded

"~loaded": boolean = false

`Readonly`~schema

"~schema": { compiled: TObject; defined: S }

`Readonly`config

config: StaticSchema<S>

Proxy to access configuration properties directly. Example: kfg.config.database.port

Accessors

driver

get driver(): D
Returns D
- Defined in src/kfg.ts:28

schema

get schema(): S
Returns S
- Defined in src/kfg.ts:32

Methods

conf

conf<P extends string>(path: P): DeepGet<S, P>
Type Parameters
- P extends string
Parameters
- path: P
Returns DeepGet<S, P>
- Defined in src/kfg.ts:240

del

del<P extends string>(path: P): inPromise<D["async"], void>
Type Parameters
- P extends string
Parameters
- path: P
Returns inPromise<D["async"], void>
- Defined in src/kfg.ts:211

get

get<P extends string>(path: P): DeepGet<StaticSchema<S>, P>
Type Parameters
- P extends string
Parameters
- path: P
Returns DeepGet<StaticSchema<S>, P>
- Defined in src/kfg.ts:126

has

has<P extends string>(...paths: P[]): boolean
Type Parameters
- P extends string
Parameters
- ...paths: P[]
Returns boolean
- Defined in src/kfg.ts:233

inject

inject(data: Partial<StaticSchema<S>>): inPromise<D["async"], void>
Parameters
- data: Partial<StaticSchema<S>>
Returns inPromise<D["async"], void>
- Defined in src/kfg.ts:193

insert

insert<P extends string>(
path: P,
partial: Partial<DeepGet<StaticSchema<S>, P>>,
): inPromise<D["async"], void>
Type Parameters
- P extends string
Parameters
- path: P
- partial: Partial<DeepGet<StaticSchema<S>, P>>
Returns inPromise<D["async"], void>
- Defined in src/kfg.ts:163

load

load(
options?: Partial<D["config"]> & { only_importants?: boolean },
): inPromise<D["async"], void>
Loads the configuration from the driver.
Parameters
- Optionaloptions: Partial<D["config"]> & { only_importants?: boolean }
Returns inPromise<D["async"], void>
- Defined in src/kfg.ts:70

reload

reload(
options?: Partial<D["config"]> & { only_importants?: boolean },
): inPromise<D["async"], void>
Parameters
- Optionaloptions: Partial<D["config"]> & { only_importants?: boolean }
Returns inPromise<D["async"], void>
- Defined in src/kfg.ts:111

root

root<P extends string>(path: P): DeepGet<StaticSchema<S>, P>
Type Parameters
- P extends string
Parameters
- path: P
Returns DeepGet<StaticSchema<S>, P>
- Defined in src/kfg.ts:131

save

save(): inPromise<D["async"], void>
Returns inPromise<D["async"], void>
- Defined in src/kfg.ts:121

schematic

schematic<P extends string>(path: P): DeepGet<S, P>
Type Parameters
- P extends string
Parameters
- path: P
Returns DeepGet<S, P>
- Defined in src/kfg.ts:247

set

set<P extends string>(
    path: P,
    value: DeepGet<StaticSchema<S>, P>,
    descriptionOrOptions?: string | { description?: string },
): inPromise<D["async"], void>
Type Parameters
- P extends string
Parameters
- path: P
- value: DeepGet<StaticSchema<S>, P>
- OptionaldescriptionOrOptions: string | { description?: string }
Returns inPromise<D["async"], void>
- Defined in src/kfg.ts:135

toJSON

toJSON(): inPromise<D["async"], StaticSchema<S>>
Returns inPromise<D["async"], StaticSchema<S>>
- Defined in src/kfg.ts:276