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

Class: DefaultHandlerRegistry

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

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

Implements

• HandlerRegistry

Constructors

Constructor

new DefaultHandlerRegistry(): DefaultHandlerRegistry;

Returns

DefaultHandlerRegistry

Methods

get()

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

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

Gets all registered message handlers for a given message name

Type Parameters

Type Parameter
MessageType extends MessageBase

Parameters

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

Returns

HandlerDefinition<MessageType>[]

Implementation of

HandlerRegistry.get

---

getClassHandlers()

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

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

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

Returns

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

Implementation of

HandlerRegistry.getClassHandlers

---

getExternallyManagedTopicIdentifiers()

getExternallyManagedTopicIdentifiers(): string[];

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

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[]

Implementation of

HandlerRegistry.getExternallyManagedTopicIdentifiers

---

getMessageConstructor()

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

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

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
T extends Message

Parameters

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

Returns

| ClassConstructor<T> | undefined

Implementation of

HandlerRegistry.getMessageConstructor

---

getMessageNames()

getMessageNames(): string[];

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

Retrieves a list of all messages that have handler registrations

Returns

string[]

Implementation of

HandlerRegistry.getMessageNames

---

getResolvers()

getResolvers(): HandlerResolver[];

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

Gets all registered message handler resolvers

Returns

HandlerResolver[]

Implementation of

HandlerRegistry.getResolvers

---

register()

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

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

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

Implementation of

HandlerRegistry.register

---

registerCustom()

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

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

Type Parameters

Type Parameter
TMessage

Parameters

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

Returns

void

Implementation of

HandlerRegistry.registerCustom

---

reset()

reset(): void;

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

Removes all handlers from the registry

Returns

void

Implementation of

HandlerRegistry.reset