Kfg Documentation
    Preparing search index...

    Class KfgDriver<C, Async>

    The base class for all drivers.

    Type Parameters

    • C extends DriverConfig

      The type of the driver configuration.

    • Async extends boolean

      The type of the async flag.

    Implements

    Index

    Constructors

    constructor

    Properties

    async config definition identify onDelete? onGet? onHas? onInject? onMerge? onMount? onRequest? onToJSON? onUnmount? onUpdate? save?

    Methods

    del get has inject insert mount request saveTo set toJSON unmount

    Constructors

    Properties

    async: Async
    config: C
    definition: Driver<Async, C>

    The driver definition.

    identify: string
    onDelete?: (
        kfg: Kfg<KfgDriver<C, Async>, Record<string, TAny>>,
        opts: any,
    ) => inPromise<Async, void>
    onGet?: (
        kfg: Kfg<KfgDriver<C, Async>, Record<string, TAny>>,
        opts: any,
    ) => inPromise<Async, any>
    onHas?: (
        kfg: Kfg<KfgDriver<C, Async>, Record<string, TAny>>,
        opts: any,
    ) => inPromise<Async, boolean>
    onInject?: (
        kfg: Kfg<KfgDriver<C, Async>, Record<string, TAny>>,
        opts: any,
    ) => inPromise<Async, void>
    onMerge?: (
        kfg: Kfg<KfgDriver<C, Async>, Record<string, TAny>>,
        opts: any,
    ) => inPromise<Async, void>
    onMount?: (
        kfg: Kfg<KfgDriver<C, Async>, Record<string, TAny>>,
        opts?: any,
    ) => inPromise<Async, any>
    onRequest?: (
        kfg: Kfg<KfgDriver<C, Async>, Record<string, TAny>>,
        opts: any,
    ) => inPromise<Async, void>
    onToJSON?: (
        kfg: Kfg<KfgDriver<C, Async>, Record<string, TAny>>,
    ) => inPromise<Async, any>
    onUnmount?: (kfg: Kfg<KfgDriver<C, Async>, Record<string, TAny>>) => void
    onUpdate?: (
        kfg: Kfg<KfgDriver<C, Async>, Record<string, TAny>>,
        opts: any,
    ) => inPromise<Async, void>
    save?: (
        kfg: Kfg<KfgDriver<C, Async>, Record<string, TAny>>,
        data?: any,
    ) => inPromise<Async, void>

    Methods

    • Parameters

      • kfg: any
      • key: string
      • value: any
      • Optionaloptions: { description?: string }

      Returns inPromise<Async, void>

    • Unmounts the driver.

      Parameters

      • kfg: any

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods