Class KfgDriver<Config, Async>Abstract

constructor

• new KfgDriver<Config extends Record<string, any>, Async extends boolean>(
      options: KfgDriverOptions<Config, Async>,
  ): KfgDriver<Config, Async>

  Type Parameters

  • Config extends Record<string, any>
  • Async extends boolean

  Parameters

  • options: KfgDriverOptions<Config, Async>

  Returns KfgDriver<Config, Async>

Readonlyasync

config

ReadonlyforceExit

Readonlyname

Optionaldelete

• delete?(key: string): inPromise<Async, void>

  Optional hook for deletion. Use this ONLY if the driver handles atomic deletion. If implemented, Kfg.del() will call this INSTEAD of save().

  Parameters

  • key: string

    The key deleted.

  Returns inPromise<Async, void>

OptionalformatError

• formatError?(errors: any[]): string

  Optional hook to format validation errors.

  Parameters

  • errors: any[]

    The array of errors from TypeBox/Value.

  Returns string

  A formatted string or undefined to use default formatting.

Abstractload

• load(schema: SchemaDefinition): inPromise<Async, Record<string, any>>

  Loads the configuration from the source.

  Parameters

  • schema: SchemaDefinition

    The schema definition.

  Returns inPromise<Async, Record<string, any>>

  The loaded configuration object.

Abstractsave

• save(
      data: Record<string, any>,
      options?: { description?: string; path?: string },
  ): inPromise<Async, void>

  Saves the configuration to the source.

  Parameters

  • data: Record<string, any>

    The full configuration object.

  • Optionaloptions: { description?: string; path?: string }

    Optional metadata for the save operation (e.g. description for a specific update).

  Returns inPromise<Async, void>

Optionaltransaction

• transaction?(
      schema: SchemaDefinition,
      fn: (current: Record<string, any>) => Record<string, any>,
  ): inPromise<Async, void>

  Optional transactional read-modify-write. When implemented, Kfg.mutate() uses it to make the whole load→modify→save cycle atomic across processes (preventing lost updates). fn receives the freshly-read raw config and returns the raw config to persist.

  Parameters

  • schema: SchemaDefinition
  • fn: (current: Record<string, any>) => Record<string, any>

  Returns inPromise<Async, void>

Optionalupdate

• update?(key: string, value: any, description?: string): inPromise<Async, void>

  Optional hook for updates. Use this ONLY if the driver handles atomic updates and doesn't need the full object every time. If implemented, Kfg.set() will call this INSTEAD of save().

  Parameters

  • key: string

    The key updated (dot notation).

  • value: any

    The new value.

  • Optionaldescription: string

  Returns inPromise<Async, void>