Class JsonDriver

Hierarchy (View Summary)

KfgDriver<{ keyroot?: boolean; path?: string }, false>
- JsonDriver

Index

Constructors

Properties

async config forceExit name

Methods

buildDefault delete? formatError load merge save update?

Constructors

constructor

new JsonDriver(config?: { keyroot?: boolean; path?: string }): JsonDriver
Parameters
- config: { keyroot?: boolean; path?: string } = {}
Returns JsonDriver
Overrides KfgDriver.constructor
- Defined in src/drivers/json-driver.ts:13

Properties

`Readonly`async

async: false

config

config: { keyroot?: boolean; path?: string }

`Readonly`forceExit

forceExit: boolean

`Readonly`name

name: string

Methods

`Protected`buildDefault

buildDefault(schema: SchemaDefinition): Record<string, any>
Parameters
- schema: SchemaDefinition
Returns Record<string, any>
Inherited from KfgDriver.buildDefault
- Defined in src/kfg-driver.ts:65

`Optional`delete

delete?(key: string): 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 void
Inherited from KfgDriver.delete
- Defined in src/kfg-driver.ts:54

formatError

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.
Overrides KfgDriver.formatError
- Defined in src/drivers/json-driver.ts:84

load

load(schema: SchemaDefinition): Record<string, any>
Loads the configuration from the source.
Parameters
- schema: SchemaDefinition
  The schema definition.
Returns Record<string, any>
The loaded configuration object.
Overrides KfgDriver.load
- Defined in src/drivers/json-driver.ts:17

`Protected`merge

merge(target: object, source: object): any
Parameters
- target: object
- source: object
Returns any
Inherited from KfgDriver.merge
- Defined in src/kfg-driver.ts:69

save

save(
data: Record<string, any>,
options?: { description?: string; path?: string },
): 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 void
Overrides KfgDriver.save
- Defined in src/drivers/json-driver.ts:55

`Optional`update

update?(key: string, value: any, description?: string): 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 void
Inherited from KfgDriver.update
- Defined in src/kfg-driver.ts:46