Kfg Documentation
    Preparing search index...

    Interface Driver<AsyncDriver, Config>

    The interface for a Driver definition.

    interface Driver<AsyncDriver extends boolean, Config extends DriverConfig = {}> {
        async: AsyncDriver;
        config?: Partial<Config>;
        identify: string;
        onDelete?: (
            kfg: Kfg<KfgDriver<Config, AsyncDriver>, Record<string, TAny>>,
            opts: any,
        ) => inPromise<AsyncDriver, void>;
        onGet?: (
            kfg: Kfg<KfgDriver<Config, AsyncDriver>, Record<string, TAny>>,
            opts: any,
        ) => inPromise<AsyncDriver, any>;
        onHas?: (
            kfg: Kfg<KfgDriver<Config, AsyncDriver>, Record<string, TAny>>,
            opts: any,
        ) => inPromise<AsyncDriver, boolean>;
        onInject?: (
            kfg: Kfg<KfgDriver<Config, AsyncDriver>, Record<string, TAny>>,
            opts: any,
        ) => inPromise<AsyncDriver, void>;
        onMerge?: (
            kfg: Kfg<KfgDriver<Config, AsyncDriver>, Record<string, TAny>>,
            opts: any,
        ) => inPromise<AsyncDriver, void>;
        onMount?: (
            kfg: Kfg<KfgDriver<Config, AsyncDriver>, Record<string, TAny>>,
            opts?: any,
        ) => inPromise<AsyncDriver, any>;
        onRequest?: (
            kfg: Kfg<KfgDriver<Config, AsyncDriver>, Record<string, TAny>>,
            opts: any,
        ) => inPromise<AsyncDriver, void>;
        onToJSON?: (
            kfg: Kfg<KfgDriver<Config, AsyncDriver>, Record<string, TAny>>,
        ) => inPromise<AsyncDriver, any>;
        onUnmount?: (
            kfg: Kfg<KfgDriver<Config, AsyncDriver>, Record<string, TAny>>,
        ) => void;
        onUpdate?: (
            kfg: Kfg<KfgDriver<Config, AsyncDriver>, Record<string, TAny>>,
            opts: any,
        ) => inPromise<AsyncDriver, void>;
        save?: (
            kfg: Kfg<KfgDriver<Config, AsyncDriver>, Record<string, TAny>>,
            data?: any,
        ) => inPromise<AsyncDriver, void>;
    }

    Type Parameters

    Implemented by

    Index

    Properties

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