Interface IAdapterHook<AdapterContextType, RawResponseType>

AdapterHook Interface.

Represents lifecycle hooks that can be defined for the adapter, such as initialization, pre-handling, and termination.

interface IAdapterHook<AdapterContextType = any, RawResponseType = any> {
    onAdapterMiddlewareProcessed?: PipelineHookListener<
        AdapterContextType,
        IAdapterEventBuilder<
            RawResponseOptions,
            IRawResponseWrapper<RawResponseType>,
        >,
        any[],
    >;
    onBuildingIncomingEvent?: AdapterHookListener<AdapterContextType>;
    onBuildingRawResponse?: AdapterHookListener<AdapterContextType>;
    onHandlingAdapterError?: AdapterHookListener<AdapterContextType>;
    onProcessingAdapterMiddleware?: PipelineHookListener<
        AdapterContextType,
        IAdapterEventBuilder<
            RawResponseOptions,
            IRawResponseWrapper<RawResponseType>,
        >,
        any[],
    >;
    onStart?: AdapterHookListener<AdapterContextType>;
    onStop?: AdapterHookListener<AdapterContextType>;
}

Type Parameters

AdapterContextType = any
RawResponseType = any

Index

Properties

onAdapterMiddlewareProcessed? onBuildingIncomingEvent? onBuildingRawResponse? onHandlingAdapterError? onProcessingAdapterMiddleware? onStart? onStop?

Properties

`Optional`onAdapterMiddlewareProcessed

onAdapterMiddlewareProcessed?: PipelineHookListener<
    AdapterContextType,
    IAdapterEventBuilder<
        RawResponseOptions,
        IRawResponseWrapper<RawResponseType>,
    >,
    any[],
>

`Optional`onBuildingIncomingEvent

onBuildingIncomingEvent?: AdapterHookListener<AdapterContextType>

`Optional`onBuildingRawResponse

onBuildingRawResponse?: AdapterHookListener<AdapterContextType>

`Optional`onHandlingAdapterError

onHandlingAdapterError?: AdapterHookListener<AdapterContextType>

`Optional`onProcessingAdapterMiddleware

onProcessingAdapterMiddleware?: PipelineHookListener<
    AdapterContextType,
    IAdapterEventBuilder<
        RawResponseOptions,
        IRawResponseWrapper<RawResponseType>,
    >,
    any[],
>

`Optional`onStart

onStart?: AdapterHookListener<AdapterContextType>

`Optional`onStop

onStop?: AdapterHookListener<AdapterContextType>