BusConfiguration
Last updated
Was this helpful?
Last updated
Was this helpful?
Creates a configuration in order to initialize a new .
Registers a class handler that receives a message and performs a unit of work. When Bus is initialized it will configure the transport to subscribe to the type of message handled by the handler and upon receipt will forward the message through to the handle()
function.
classHandler
A class responsible for handling messages that implements Handler
None
See also , .
Registers a function handler that receives a message and performs a unit of work. When Bus is initialized it will configure the transport to subscribe to the type of message handled by the function handler and upon receipt will forward the message to the function.
functionHandler
A functional handler mapping initialized using handlerFor
None
Registers a custom handler that receives messages from external systems, or messages that don't implement the Message interface from @node-ts/bus-messages.
messageHandler
A handler that receives the custom message
None
customResolver
A discriminator that determines if an incoming message should be mapped to this handler
None
Registers a workflow definition so that all of the messages it depends on will be subscribed to and forwarded to the handlers inside the workflow.
workflow
Workflow definition to register
None
Configures Bus to use a different transport than the default MemoryQueue.
transport
A configured transport to use
None
Configures Bus to use a different logging provider than the default consoler logger.
loggerFactory
A factory that creates a new logger
None
Configures Bus to use a different serialization provider. The provider is responsible for transforming messages to/from a serialized representation, as well as ensuring all object properties are a strong type.
serializer
Serializer to use
None
Configures Bus to use a different persistence provider than the default InMemoryPersistence provider. This is used to persist workflow data and is unused if not using workflows.
persistence
Persistence provider to use
None
Sets the message handling concurrency beyond the default value of 1, which will increase the number of messages handled in parallel.concurrency
concurrency
The number of messages that can be handled in parallel
None
Use a local dependency injection/IoC container to resolve handlers and workflows.
Configures Bus to use a different persistence provider than the default InMemoryPersistence provider. This is used to persist workflow data and is unused if not using workflows.
containerAdapter
An adapter that allows Bus to resolve class instances from the underlying IoC container
None
Run custom middleware before/after the point a message is read from the transport and then dispatched to handlers and workflow handlers.
middleware
A middleware function that will be executed after a message is read from the transport and before it is dispatched to handlers.
None
Configure the bus to use a different retry strategy instead of the default.
retryStrategy
An implementation of RetryStrategy
that calculates the delay between retrying failed messages.
DefaultRetryStrategy
Initialize a configured BusInstance. This should be called after all options have been provided for the configuration.
See also , .
See also .
See also .
See also .
See also .
See also .
See also .
See also
See also .
See also .