Function drain

drain<S, C, E>(factory, options): Promise<{
    error?: string;
    times: number;
    total: number;
}>
Drains consumer subscription by polling events until the end of the stream is reached or an error occurs
Type Parameters
- S extends State
- C extends Messages
- E extends Messages
Parameters
- factory: EventHandlerFactory<S, C, E> | ProjectorFactory<S, E>
  
  event handler factory (policy, process manager, or projector)
- options: PollOptions
  
  poll options
Returns Promise<{
    error?: string;
    times: number;
    total: number;
}>
number of handled events, and error message when something fails
- Defined in libs/eventually/src/handlers/poll.ts:91

Generated using TypeDoc