API reference / @node-ts/bus-core / HandlerRegistry

Interface: HandlerRegistry

Defined in: packages/bus-core/src/handler/handler-registry.ts:46

An internal singleton that contains all registrations of messages to functions that handle those messages.

Methods

get()

get<MessageType>(loggerFactory, message): HandlerDefinition<MessageType>[];

Defined in: packages/bus-core/src/handler/handler-registry.ts:68

Gets all registered message handlers for a given message name

Type Parameters

Type Parameter
MessageType extends Message

Parameters

Parameter	Type	Description
loggerFactory	LoggerFactory	-
message	object	A message that has been received from the bus

Returns

HandlerDefinition<MessageType>[]

---

getClassHandlers()

getClassHandlers(): Handler<MessageBase, MessageAttributes<MessageAttributeMap, MessageAttributeMap>>[];

Defined in: packages/bus-core/src/handler/handler-registry.ts:102

Gets a list of all class based handlers that have been registered

Returns

Handler<MessageBase, MessageAttributes<MessageAttributeMap, MessageAttributeMap>>[]

---

getExternallyManagedTopicIdentifiers()

getExternallyManagedTopicIdentifiers(): string[];

Defined in: packages/bus-core/src/handler/handler-registry.ts:92

Retrieves an array of all topic arns that are managed externally but require subscribing to as there are custom handlers that handle those messages.

Returns

string[]

---

getMessageConstructor()

getMessageConstructor<TMessage>(messageName): 
  | ClassConstructor<TMessage>
  | undefined;

Defined in: packages/bus-core/src/handler/handler-registry.ts:84

Returns the class that received messages are created from, for a message that has a handler registration. That's the message class, or Object for a message declared with defineCommand or defineEvent, whose messages are plain objects.

Type Parameters

Type Parameter
TMessage extends Message

Parameters

Parameter	Type	Description
messageName	string	Message to get a class constructor for

Returns

| ClassConstructor<TMessage> | undefined

---

getMessageNames()

getMessageNames(): string[];

Defined in: packages/bus-core/src/handler/handler-registry.ts:76

Retrieves a list of all messages that have handler registrations

Returns

string[]

---

getResolvers()

getResolvers(): HandlerResolver[];

Defined in: packages/bus-core/src/handler/handler-registry.ts:97

Gets all registered message handler resolvers

Returns

HandlerResolver[]

---

register()

register<TMessage>(messageType, handler): void;

Defined in: packages/bus-core/src/handler/handler-registry.ts:54

Registers that a function handles a particular message type. The message's name is read from the static NAME of messageType, without constructing it.

Type Parameters

Type Parameter
TMessage extends Message

Parameters

Parameter	Type	Description
messageType	MessageDeclaration<TMessage>	The message class, or the definition from defineCommand or defineEvent, to handle
handler	HandlerDefinition<TMessage>	The function handler to dispatch messages to as they arrive

Returns

void

Throws

MessageNameMissing if messageType has no static NAME

---

registerCustom()

registerCustom<TMessage>(handler, customResolver): void;

Defined in: packages/bus-core/src/handler/handler-registry.ts:59

Type Parameters

Type Parameter
TMessage extends MessageBase

Parameters

Parameter	Type
handler	HandlerDefinition<TMessage>
customResolver	CustomResolver<TMessage>

Returns

void

---

reset()

reset(): void;

Defined in: packages/bus-core/src/handler/handler-registry.ts:107

Removes all handlers from the registry

Returns

void