Global

Type Definitions

Consumer

Type:
  • Promise
Properties:
Name Type Description
consumerTag string A unique identifier for a consumer/subscriber
Source:

Kewpie

Type:
  • Object
Properties:
Name Type Description
publish function
subscribe function
unsubscribe function
connect function
close function
errors Object The possible errors that can be returned from methods
Properties
Name Type Description
blankQueueError Error The error returned if the passed queue name is blank
blankTaskError Error The error returned if the passed task is blank
opts Object.<kewpieOpts> The resolved options that Kewpie is instantiated with
Source:

kewpieOpts

Type:
  • Object
Properties:
Name Type Description
passedOpts.deadLetterExchange string The name of the exchange to expired and nacked messages to
passedOpts.deadLetterQueue string The name of the queue that dead lettered messages will come to reside in after being routed from the dead letter exchange
passedOpts.kewpie string The name of the main exchange all messages are `publish`ed to
passedOpts.maxPriority number The maximum priority level that messages on queues may have
passedOpts.defaultExpiration number The default expiration time for messages. This prevents unfulfillable tasks from clogging up the queue forever (in MS)
passedOpts.maxConnectionAttempts number The maximum amount of times kewpie will attempt to connect to the RabbitMQ server before giving up and throwing
passedOpts.delayMS number The delay in MS to wait between retrying operations before kewpie has successfully connected to the RabbitMQ server on initialisation
passedOpts.enableDelayed number Whether to enable delayed messaging by creating the main exchange as a delayed message exchange. This requires the experimental delayed messages plugin to RabbitMQ
Source: