Interface IEventSource

Hierarchy

Pick<IPublisher<IEvent>, "listen" | "subscribe" | "unsubscribe">
- IEventSource

Index

Methods

appendToStream listen readFromStream subscribe unsubscribe

Methods

appendToStream

appendToStream(eventList: IEvent<unknown>[]): Promise<IEvent<unknown>[]>
Append the provided events to the event stream
Parameters
- eventList: IEvent<unknown>[]
Returns Promise<IEvent<unknown>[]>
- Defined in moirae/core/lib/interfaces/event-source.interface.ts:10

listen

listen(handlerFn: ((event: IEvent<unknown>) => void)): string
Listen to the bus asynchronously but without triggering event acknowledgement. Will only be called for events processed by this node.
Parameters
- handlerFn: ((event: IEvent<unknown>) => void)
  - - (event: IEvent<unknown>): void
    - Parameters
      
      event: IEvent<unknown>
      
      Returns void
Returns string
Inherited from Pick.listen
- Defined in moirae/core/lib/interfaces/publisher.interface.ts:19

readFromStream

readFromStream(streamId: string): Promise<IEvent<unknown>[]>
Read all events from the stream in order
Parameters
- streamId: string
Returns Promise<IEvent<unknown>[]>
- Defined in moirae/core/lib/interfaces/event-source.interface.ts:14

subscribe

subscribe(handlerFn: ((event: IEvent<unknown>) => void)): string
Subscribe to the bus. Should only be called ONCE by the relevant bus as will trigger acknowledgements.
Parameters
- handlerFn: ((event: IEvent<unknown>) => void)
  - - (event: IEvent<unknown>): void
    - Parameters
      
      event: IEvent<unknown>
      
      Returns void
Returns string
Inherited from Pick.subscribe
- Defined in moirae/core/lib/interfaces/publisher.interface.ts:32

unsubscribe

unsubscribe(key: string): void
Unsubscribe from the bus
Parameters
- key: string
Returns void
Inherited from Pick.unsubscribe
- Defined in moirae/core/lib/interfaces/publisher.interface.ts:36

Generated using TypeDoc