Class Kfg<D, S>

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>

~cache

Readonly~driver

~loaded

Readonly~schema

Readonlyconfig

driver

• get driver(): D

  Returns D

schema

• get schema(): S

  Returns S

conf

• conf<P extends string>(path: P): DeepGet<S, P>

  Type Parameters

  • P extends string

  Parameters

  • path: P

  Returns DeepGet<S, P>

del

• del<P extends string>(path: P): inPromise<D["async"], void>

  Type Parameters

  • P extends string

  Parameters

  • path: P

  Returns inPromise<D["async"], void>

get

• get<P extends string>(path: P): DeepGet<StaticSchema<S>, P>

  Type Parameters

  • P extends string

  Parameters

  • path: P

  Returns DeepGet<StaticSchema<S>, P>

has

• has<P extends string>(...paths: P[]): boolean

  Type Parameters

  • P extends string

  Parameters

  • ...paths: P[]

  Returns boolean

inject

• inject(data: Partial<StaticSchema<S>>): inPromise<D["async"], void>

  Parameters

  • data: Partial<StaticSchema<S>>

  Returns inPromise<D["async"], void>

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>

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>

mutate

• mutate(
      fn: (draft: StaticSchema<S>) => StaticSchema<S> | undefined,
  ): inPromise<D["async"], void>

  Transactional read-modify-write. Reads the latest persisted state, runs fn to mutate it, validates, and persists — atomically across processes when the driver supports it (preventing lost updates from concurrent writers). Falls back to load→mutate→save when it does not. fn may mutate the draft in place or return a replacement.

  Parameters

  • fn: (draft: StaticSchema<S>) => StaticSchema<S> | undefined

  Returns inPromise<D["async"], void>

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>

root

• root<P extends string>(path: P): DeepGet<StaticSchema<S>, P>

  Type Parameters

  • P extends string

  Parameters

  • path: P

  Returns DeepGet<StaticSchema<S>, P>

save

• save(): inPromise<D["async"], void>

  Returns inPromise<D["async"], void>

schematic

• schematic<P extends string>(path: P): DeepGet<S, P>

  Type Parameters

  • P extends string

  Parameters

  • path: P

  Returns DeepGet<S, P>

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>

toJSON

• toJSON(): inPromise<D["async"], StaticSchema<S>>

  Returns inPromise<D["async"], StaticSchema<S>>