DocStrap

Global

Type Definitions

Channel

A Channel object, part of the amqplib. Search amqplib documentation for more information

Type:
  • Object
Source:

customLogger

The configuration object that must be passed for an amqp connection string to be properly built

Type:
  • Object
Properties:
Name Type Description
error function

custom implementation of customLogger.error
info function

custom implementation of customLogger.info
debug function

custom implementation of customLogger.debug
fatal function

custom implementation of customLogger.fatal
trace function

custom implementation of customLogger.trace
warn function

custom implementation of customLogger.warn
Source:

RabbitConfiguration

The configuration object that must be passed for an amqp connection string to be properly built

Type:
  • Object
Properties:
Name Type Description
rabbitmqserver String

RabbitMqServer string IP or Domain.
rabbitmqport Number

RabbitMqServer Port.
rabbitmqusername String

RabbitMqServer username.
rabbitmqpassword String

RabbitMqServer password.
rabbitheartbeat Number

optional, sets the client heartbeat with the server. Helps prevent TCP timeouts if rabbit server does not have heartbeat service enabled
vhost String

RabbitMqServer vhost.
Source:

RabbitHandler

The configuration object that must be passed for an amqp connection string to be properly built

Type:
  • Object
Properties:
Name Type Description
handlerFunction function

The callback function that messages will be returned and processed on
queueConfig String

The queue that it will connect to ex "My.First.Queue"
messageRate Number

The amount of messages that can be received at a time. Once this amount of messages is ack more will come in (if available)
Source:

RabbitHandlers

An array of RabbitHandlers, each rabbit handler has a configuration for a queue to connect to

Type:
Source: