@eveble/eveble

Hierarchy

• Controller

  ↳ Sender

  ↳ Publisher

  ↳ EventSourceable

Implemented by

• Aggregate
• CommandBus
• CommandHandlingMixin
• CommandSchedulingService
• CommandSchedulingService
• EventBus
• EventHandlingMixin
• EventSourceable
• OneToManyHandlingMixin
• OneToOneHandlingMixin
• Process
• Projection
• Service
• Service

Index

Methods

• ensureHandleability
• getHandleableTypes
• getHandled
• getHandledTypes
• getHandler
• getHandlerOrThrow
• getHandlers
• handle
• handles
• hasHandler
• initialize
• isHandleabe
• overrideHandler
• registerHandler
• removeHandler
• setHandleableTypes
• subscribes

Methods

ensureHandleability

▸ ensureHandleability(messageType: MessageType‹Message›, handleableTypes: MessageType‹Message› | MessageType‹Message›[]): boolean

Parameters:

Name	Type
messageType	MessageType‹Message›
handleableTypes	MessageType‹Message› | MessageType‹Message›[]

Returns: boolean

▸ ensureHandleability(messageType: MessageType‹Message›, handleableTypes: MessageType‹Message› | MessageType‹Message›[]): boolean

Parameters:

Name	Type
messageType	MessageType‹Message›
handleableTypes	MessageType‹Message› | MessageType‹Message›[]

Returns: boolean

---

getHandleableTypes

▸ getHandleableTypes(): MessageType‹Message›[]

Returns: MessageType‹Message›[]

▸ getHandleableTypes(): MessageType‹Message›[]

Returns: MessageType‹Message›[]

---

getHandled

▸ getHandled(messageType: MessageType‹Message›): MessageType‹Message›[]

Parameters:

Name	Type
messageType	MessageType‹Message›

Returns: MessageType‹Message›[]

▸ getHandled(messageType: MessageType‹Message›): MessageType‹Message›[]

Parameters:

Name	Type
messageType	MessageType‹Message›

Returns: MessageType‹Message›[]

---

getHandledTypes

▸ getHandledTypes(): MessageType‹Message›[]

Returns: MessageType‹Message›[]

▸ getHandledTypes(): MessageType‹Message›[]

Returns: MessageType‹Message›[]

---

getHandler

▸ getHandler(messageType: MessageType‹Message›): Handler | Handler[] | undefined

Parameters:

Name	Type
messageType	MessageType‹Message›

Returns: Handler | Handler[] | undefined

▸ getHandler(messageType: MessageType‹Message›): Handler | Handler[] | undefined

Parameters:

Name	Type
messageType	MessageType‹Message›

Returns: Handler | Handler[] | undefined

---

getHandlerOrThrow

▸ getHandlerOrThrow(messageType: MessageType‹Message›): Handler | Handler[]

Parameters:

Name	Type
messageType	MessageType‹Message›

Returns: Handler | Handler[]

▸ getHandlerOrThrow(messageType: MessageType‹Message›): Handler | Handler[]

Parameters:

Name	Type
messageType	MessageType‹Message›

Returns: Handler | Handler[]

---

getHandlers

▸ getHandlers(): Map‹MessageType‹Message›, Handler | Handler[]›

Returns: Map‹MessageType‹Message›, Handler | Handler[]›

▸ getHandlers(): Map‹MessageType‹Message›, Handler | Handler[]›

Returns: Map‹MessageType‹Message›, Handler | Handler[]›

---

handle

▸ handle(message: Message, execution?: Execution): Promise‹any›

Parameters:

Name	Type
message	Message
execution?	Execution

Returns: Promise‹any›

▸ handle(message: Message, execution?: Execution): Promise‹any›

Parameters:

Name	Type
message	Message
execution?	Execution

Returns: Promise‹any›

---

handles

▸ handles(): Map‹MessageType‹Command›, Handler›

Returns: Map‹MessageType‹Command›, Handler›

▸ handles(): Map‹MessageType‹Command›, Handler›

Returns: Map‹MessageType‹Command›, Handler›

---

hasHandler

▸ hasHandler(messageType: MessageType‹Message›): boolean

Parameters:

Name	Type
messageType	MessageType‹Message›

Returns: boolean

▸ hasHandler(messageType: MessageType‹Message›): boolean

Parameters:

Name	Type
messageType	MessageType‹Message›

Returns: boolean

---

initialize

▸ initialize(): void

Returns: void

▸ initialize(): void

Returns: void

---

isHandleabe

▸ isHandleabe(messageType: MessageType‹Message›): boolean

Parameters:

Name	Type
messageType	MessageType‹Message›

Returns: boolean

▸ isHandleabe(messageType: MessageType‹Message›): boolean

Parameters:

Name	Type
messageType	MessageType‹Message›

Returns: boolean

---

overrideHandler

▸ overrideHandler(messageType: MessageType‹Message›, handler: Handler): void

Parameters:

Name	Type
messageType	MessageType‹Message›
handler	Handler

Returns: void

▸ overrideHandler(messageType: MessageType‹Message›, handler: Handler): void

Parameters:

Name	Type
messageType	MessageType‹Message›
handler	Handler

Returns: void

---

registerHandler

▸ registerHandler(messageType: MessageType‹Message›, handler: Handler, shouldOverride?: boolean): void

Parameters:

Name	Type
messageType	MessageType‹Message›
handler	Handler
shouldOverride?	boolean

Returns: void

▸ registerHandler(messageType: MessageType‹Message›, handler: Handler, shouldOverride?: boolean): void

Parameters:

Name	Type
messageType	MessageType‹Message›
handler	Handler
shouldOverride?	boolean

Returns: void

---

removeHandler

▸ removeHandler(messageType: MessageType‹Message›): void

Parameters:

Name	Type
messageType	MessageType‹Message›

Returns: void

▸ removeHandler(messageType: MessageType‹Message›): void

Parameters:

Name	Type
messageType	MessageType‹Message›

Returns: void

---

setHandleableTypes

▸ setHandleableTypes(handleableTypes: MessageType‹Message› | MessageType‹Message›[]): void

Parameters:

Name	Type
handleableTypes	MessageType‹Message› | MessageType‹Message›[]

Returns: void

▸ setHandleableTypes(handleableTypes: MessageType‹Message› | MessageType‹Message›[]): void

Parameters:

Name	Type
handleableTypes	MessageType‹Message› | MessageType‹Message›[]

Returns: void

---

subscribes

▸ subscribes(): Map‹MessageType‹Event›, Handler›

Returns: Map‹MessageType‹Event›, Handler›

▸ subscribes(): Map‹MessageType‹Event›, Handler›

Returns: Map‹MessageType‹Event›, Handler›