Interface EventoSendProvider<INREQ, REQ, RES>

Interface for sending data during event handling. Provides lifecycle hooks (start, send, done) for managing event communication.

interface EventoSendProvider<INREQ, REQ, RES> {
    start?(
        trigger: HandleTriggerCtx<INREQ, REQ, RES>,
    ): Promise<Result<void, Error>>;
    send<IS, OS>(
        trigger: HandleTriggerCtx<INREQ, REQ, RES>,
        data: IS,
    ): Promise<Result<OS, Error>>;
    done?(
        trigger: HandleTriggerCtx<INREQ, REQ, RES>,
    ): Promise<Result<void, Error>>;
}

Type Parameters

INREQ
The input request type
REQ
The validated request type
RES
The response type

Index

Methods

start? send done?

Methods

`Optional`start

start?(trigger: HandleTriggerCtx<INREQ, REQ, RES>): Promise<Result<void, Error>>
Optional hook called once before the first handler processes the event.
Parameters
- trigger: HandleTriggerCtx<INREQ, REQ, RES>
  The trigger context
Returns Promise<Result<void, Error>>
A Result indicating success or failure
- Defined in evento.ts:47

send

send<IS, OS>(
trigger: HandleTriggerCtx<INREQ, REQ, RES>,
data: IS,
): Promise<Result<OS, Error>>
Sends data during event handling.
Type Parameters
- IS
  Input send data type
- OS
  Output send data type
Parameters
- trigger: HandleTriggerCtx<INREQ, REQ, RES>
  The trigger context
- data: IS
  The data to send
Returns Promise<Result<OS, Error>>
A Result containing the response or an error
- Defined in evento.ts:58

`Optional`done

done?(trigger: HandleTriggerCtx<INREQ, REQ, RES>): Promise<Result<void, Error>>
Optional hook called after all handlers have finished processing.
Parameters
- trigger: HandleTriggerCtx<INREQ, REQ, RES>
  The trigger context
Returns Promise<Result<void, Error>>
A Result indicating success or failure
- Defined in evento.ts:66

Interface EventoSendProvider<INREQ, REQ, RES>

Type Parameters

Index

Methods

Methods

`Optional`start

Parameters

Returns Promise<Result<void, Error>>

send

Type Parameters

Parameters

Returns Promise<Result<OS, Error>>

`Optional`done

Parameters

Returns Promise<Result<void, Error>>

Settings

On This Page

Interface EventoSendProvider<INREQ, REQ, RES>

Type Parameters

Index

Methods

Methods

Optionalstart

Parameters

Returns Promise<Result<void, Error>>

send

Type Parameters

Parameters

Returns Promise<Result<OS, Error>>

Optionaldone

Parameters

Returns Promise<Result<void, Error>>

Settings

On This Page

`Optional`start

`Optional`done