Kfg Documentation
    Preparing search index...

    Class JsonDriver

    Hierarchy (View Summary)

    • KfgDriver<
          {
              allow_backup?: boolean
              | string;
              keyroot?: boolean;
              lock_timeout?: number;
              mutate_set?: boolean;
              path?: string;
          },
          false,
      >
      • JsonDriver
    Index

    Constructors

    constructor

    Properties

    async config forceExit name

    Methods

    buildDefault delete? formatError load merge save transaction update?

    Constructors

    • Parameters

      • config: {
            allow_backup?: string | boolean;
            keyroot?: boolean;
            lock_timeout?: number;
            mutate_set?: boolean;
            path?: string;
        } = {}

      Returns JsonDriver

    Properties

    async: false
    config: {
        allow_backup?: string | boolean;
        keyroot?: boolean;
        lock_timeout?: number;
        mutate_set?: boolean;
        path?: string;
    }
    forceExit: boolean
    name: string

    Methods

    • 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

    • 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.

    • 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

    • Locked read-modify-write: reads the current persisted config, passes it to fn, and atomically writes the result — all under one lock, so concurrent processes cannot lose updates.

      Parameters

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

      Returns 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods