README.md

RedisSMQ / Docs / API Reference

API Reference

Table of contents

Enumerations

• EConsumeMessageDeadLetterCause
• EConsumeMessageUnacknowledgedCause
• EExchangeType
• EMessagePriority
• EMessageProperty
• EMessagePropertyStatus
• EQueueDeliveryModel
• EQueueProperty
• EQueueType

Classes

• Configuration
• Consumer
• ConsumerGroups
• EventBusRedisInstance
• ExchangeDirect
• ExchangeFanOut
• ExchangeTopic
• Message
• Namespace
• Producer
• ProducibleMessage
• Queue
• QueueAcknowledgedMessages
• QueueDeadLetteredMessages
• QueueMessages
• QueuePendingMessages
• QueueRateLimit
• QueueScheduledMessages

Errors

• ConfigurationError
• ConfigurationMessageQueueSizeError
• ConfigurationMessageStoreExpireError
• ConfigurationNamespaceError
• ConsumerConsumeMessageHandlerAlreadyExistsError
• ConsumerConsumerGroupIdNotSupportedError
• ConsumerConsumerGroupIdRequiredError
• ConsumerError
• ConsumerGroupsConsumerGroupNotEmptyError
• ConsumerGroupsConsumerGroupsNotSupportedError
• ConsumerGroupsError
• ConsumerGroupsInvalidGroupIdError
• ConsumerGroupsQueueNotFoundError
• EventBusInstanceLockError
• ExchangeError
• ExchangeFanOutError
• ExchangeFanOutExchangeHasBoundQueuesError
• ExchangeFanOutQueueTypeError
• ExchangeInvalidFanOutParamsError
• ExchangeInvalidQueueParamsError
• ExchangeInvalidTopicParamsError
• ExchangeQueueIsNotBoundToExchangeError
• MessageDestinationQueueAlreadySetError
• MessageDestinationQueueRequiredError
• MessageError
• MessageInvalidParametersError
• MessageMessageExchangeRequiredError
• MessageMessageInProcessError
• MessageMessageNotDeletedError
• MessageMessageNotFoundError
• MessageMessageNotRequeuableError
• MessageMessagePropertyError
• NamespaceError
• NamespaceInvalidNamespaceError
• NamespaceNotFoundError
• ProducerError
• ProducerExchangeNoMatchedQueueError
• ProducerInstanceNotRunningError
• ProducerMessageExchangeRequiredError
• ProducerMessagePriorityRequiredError
• ProducerPriorityQueuingNotEnabledError
• ProducerQueueMissingConsumerGroupsError
• ProducerQueueNotFoundError
• ProducerScheduleInvalidParametersError
• ProducerUnknownQueueTypeError
• QueueError
• QueueInvalidQueueParameterError
• QueueMessagesConsumerGroupIdNotSupportedError
• QueueMessagesConsumerGroupIdRequiredError
• QueueMessagesError
• QueueQueueExistsError
• QueueQueueHasRunningConsumersError
• QueueQueueNotEmptyError
• QueueQueueNotFoundError
• QueueRateLimitError
• QueueRateLimitInvalidIntervalError
• QueueRateLimitInvalidLimitError
• QueueRateLimitQueueNotFoundError

Interfaces

• IConsumerConfig
• IConsumerHeartbeat
• IConsumerHeartbeatPayload
• IConsumerMessageHandlerArgs
• IEventBusConfig
• IExchange
• IMessageParams
• IMessageStateTransferable
• IMessageTransferable
• IMessagesConfig
• IMessagesConfigStorage
• IMessagesConfigStorageOptions
• IMessagesConfigStorageOptionsRequired
• IMessagesConfigStorageRequired
• IQueueConsumerGroupParams
• IQueueGroupConsumersPendingCount
• IQueueMessages
• IQueueMessagesCount
• IQueueMessagesPage
• IQueueMessagesRequeuable
• IQueueParams
• IQueueParsedParams
• IQueueProperties
• IQueueRateLimit
• IRedisSMQConfig
• IRedisSMQConfigRequired
• ITopicParams

Type Aliases

• IQueueMessagesPageParams
• TConsumerConsumeMessageEvent
• TConsumerDequeueMessageEvent
• TConsumerEvent
• TConsumerHeartbeatEvent
• TConsumerMessageHandler
• TConsumerMessageHandlerEvent
• TConsumerMessageHandlerFn
• TConsumerMessageHandlerRunnerEvent
• TConsumerRedisKeys
• TEventBusEvent
• TExchangeDirectTransferable
• TExchangeFanOutTransferable
• TExchangeTopicTransferable
• TExchangeTransferable
• TMessageConsumeOptions
• TProducerEvent
• TQueueConsumer
• TQueueEvent
• TQueueExtendedParams
• TQueueMessagesPaginationParams
• TQueueMessagesParams
• TRedisSMQEvent

Type Aliases

IQueueMessagesPageParams

Ƭ IQueueMessagesPageParams: Object

Type declaration

Name	Type
currentPage	number
offsetEnd	number
offsetStart	number
totalPages	number

---

TConsumerConsumeMessageEvent

Ƭ TConsumerConsumeMessageEvent: Object

Type declaration

Name	Type
consumer.consumeMessage.error	(err: Error, consumerId: string, queue: IQueueParsedParams) => void
consumer.consumeMessage.messageAcknowledged	(messageId: string, queue: IQueueParsedParams, messageHandlerId: string, consumerId: string) => void
consumer.consumeMessage.messageDeadLettered	(messageId: string, queue: IQueueParsedParams, messageHandlerId: string, consumerId: string, cause: EConsumeMessageDeadLetterCause) => void
consumer.consumeMessage.messageDelayed	(messageId: string, queue: IQueueParsedParams, messageHandlerId: string, consumerId: string) => void
consumer.consumeMessage.messageRequeued	(messageId: string, queue: IQueueParsedParams, messageHandlerId: string, consumerId: string) => void
consumer.consumeMessage.messageUnacknowledged	(messageId: string, queue: IQueueParsedParams, messageHandlerId: string, consumerId: string, cause: EConsumeMessageUnacknowledgedCause) => void

---

TConsumerDequeueMessageEvent

Ƭ TConsumerDequeueMessageEvent: Object

Type declaration

Name	Type
consumer.dequeueMessage.error	(err: Error, consumerId: string, queue: IQueueParsedParams) => void
consumer.dequeueMessage.messageReceived	(messageId: string, queue: IQueueParsedParams, consumerId: string) => void
consumer.dequeueMessage.nextMessage	() => void

---

TConsumerEvent

Ƭ TConsumerEvent: Object

Type declaration

Name	Type
consumer.down	(consumerId: string) => void
consumer.error	(err: Error, consumerId: string) => void
consumer.goingDown	(consumerId: string) => void
consumer.goingUp	(consumerId: string) => void
consumer.up	(consumerId: string) => void

---

TConsumerHeartbeatEvent

Ƭ TConsumerHeartbeatEvent: Object

Type declaration

Name	Type
consumerHeartbeat.error	(err: Error) => void
consumerHeartbeat.heartbeat	(consumerId: string, timestamp: number, heartbeatPayload: IConsumerHeartbeat) => void

---

TConsumerMessageHandler

Ƭ TConsumerMessageHandler: string | TConsumerMessageHandlerFn

---

TConsumerMessageHandlerEvent

Ƭ TConsumerMessageHandlerEvent: Object

Type declaration

Name	Type
consumer.messageHandler.error	(err: Error, consumerId: string, queue: IQueueParsedParams) => void

---

TConsumerMessageHandlerFn

Ƭ TConsumerMessageHandlerFn: (msg: IMessageTransferable, cb: ICallback<void>) => void

Type declaration

▸ (msg, cb): void

Parameters

Name	Type
msg	IMessageTransferable
cb	ICallback<void>

Returns

void

---

TConsumerMessageHandlerRunnerEvent

Ƭ TConsumerMessageHandlerRunnerEvent: Object

Type declaration

Name	Type
consumer.messageHandlerRunner.error	(err: Error, consumerId: string) => void

---

TConsumerRedisKeys

Ƭ TConsumerRedisKeys: ReturnType<typeof redisKeys["getConsumerKeys"]>

---

TEventBusEvent

Ƭ TEventBusEvent: Object

Type declaration

Name	Type
error	(err: Error) => void

---

TExchangeDirectTransferable

Ƭ TExchangeDirectTransferable: Object

Type declaration

Name	Type
exchangeTag	string
params	IQueueParams
type	DIRECT

---

TExchangeFanOutTransferable

Ƭ TExchangeFanOutTransferable: Object

Type declaration

Name	Type
exchangeTag	string
params	string
type	FANOUT

---

TExchangeTopicTransferable

Ƭ TExchangeTopicTransferable: Object

Type declaration

Name	Type
exchangeTag	string
params	ITopicParams
type	TOPIC

---

TExchangeTransferable

Ƭ TExchangeTransferable: TExchangeDirectTransferable | TExchangeTopicTransferable | TExchangeFanOutTransferable

---

TMessageConsumeOptions

Ƭ TMessageConsumeOptions: Object

Type declaration

Name	Type
consumeTimeout	number
retryDelay	number
retryThreshold	number
ttl	number

---

TProducerEvent

Ƭ TProducerEvent: Object

Type declaration

Name	Type
producer.down	(producerId: string) => void
producer.error	(err: Error, producerId: string) => void
producer.goingDown	(producerId: string) => void
producer.goingUp	(producerId: string) => void
producer.messagePublished	(messageId: string, queue: IQueueParsedParams, producerId: string) => void
producer.up	(producerId: string) => void

---

TQueueConsumer

Ƭ TQueueConsumer: Object

Type declaration

Name	Type
createdAt	number
hostname	string
ipAddress	string[]
pid	number

---

TQueueEvent

Ƭ TQueueEvent: Object

Type declaration

Name	Type
queue.consumerGroupCreated	(queue: IQueueParams, groupId: string) => void
queue.consumerGroupDeleted	(queue: IQueueParams, groupId: string) => void
queue.queueCreated	(queue: IQueueParams, properties: IQueueProperties) => void
queue.queueDeleted	(queue: IQueueParams) => void

---

TQueueExtendedParams

Ƭ TQueueExtendedParams: string | IQueueParams | IQueueConsumerGroupParams

---

TQueueMessagesPaginationParams

Ƭ TQueueMessagesPaginationParams: Object

Type declaration

Name	Type
consumerGroupId?	string | null
page	number
pageSize	number
queue	string | IQueueParams

---

TQueueMessagesParams

Ƭ TQueueMessagesParams: Object

Type declaration

Name	Type
consumerGroupId?	string | null
queue	string | IQueueParams

---

TRedisSMQEvent

Ƭ TRedisSMQEvent: TEventBusEvent & TConsumerEvent & TConsumerHeartbeatEvent & TConsumerMessageHandlerRunnerEvent & TConsumerMessageHandlerEvent & TConsumerConsumeMessageEvent & TConsumerDequeueMessageEvent & TProducerEvent & TQueueEvent