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
• ExchangeTopic
• Message
• Namespace
• Producer
• ProducibleMessage
• Queue
• QueueAcknowledgedMessages
• QueueDeadLetteredMessages
• QueueMessages
• QueuePendingMessages
• QueueRateLimit
• QueueScheduledMessages

Errors

• ConsumerError
• ConsumerGroupDeleteError
• ConsumerGroupIdNotFoundError
• ConsumerGroupIdNotSupportedError
• ConsumerGroupIdRequiredError
• ConsumerInvalidGroupIdError
• ConsumerMessageHandlerAlreadyExistsError
• ExchangeDirect
• ExchangeError
• ExchangeFanOut
• ExchangeFanOutError
• ExchangeInvalidDataError
• MessageDeleteError
• MessageDestinationQueueAlreadySetError
• MessageDestinationQueueRequiredError
• MessageError
• MessageExchangeRequiredError
• MessageNotFoundError
• ProducerError
• ProducerInstanceNotRunningError
• ProducerMessageExchangeRequiredError
• ProducerMessageNotPublishedError
• ProducerMessageNotScheduledError
• ProducerQueueWithoutConsumerGroupsError
• QueueError
• QueueExistsError
• QueueHasRunningConsumersError
• QueueMessageRequeueError
• QueueNamespaceNotFoundError
• QueueNotEmptyError
• QueueNotFoundError
• QueueRateLimitError

Interfaces

• IConsumableMessage
• IConsumerHeartbeat
• IConsumerHeartbeatPayload
• IConsumerMessageHandlerArgs
• IEventListener
• IExchange
• IExchangeSerialized
• IMessageSerialized
• IMessageStateSerialized
• IMessagesConfig
• IMessagesConfigStorage
• IMessagesConfigStorageOptions
• IMessagesConfigStorageOptionsRequired
• IMessagesConfigStorageRequired
• IQueueConsumerGroupParams
• IQueueGroupConsumersPendingCount
• IQueueMessages
• IQueueMessagesCount
• IQueueMessagesPage
• IQueueMessagesRequeuable
• IQueueParams
• IQueueParsedParams
• IQueueProperties
• IQueueRateLimit
• IRedisSMQConfig
• IRedisSMQConfigRequired

Type Aliases

• IQueueMessagesPageParams
• TConsumerMessageHandler
• TConsumerRedisKeys
• TEventListenersConfig
• TExchange
• TExchangeDirectBindingParams
• TExchangeFanOutBindingParams
• TExchangeSerialized
• TExchangeTopicBindingParams
• TMessageConsumeOptions
• TQueueConsumer
• TQueueExtendedParams
• TQueueMessagesPaginationParams
• TQueueMessagesParams
• TRedisSMQEvent
• TTopicParams

Functions

• disconnect

Type Aliases

IQueueMessagesPageParams

Ƭ IQueueMessagesPageParams: Object

Type declaration

Name	Type
currentPage	number
offsetEnd	number
offsetStart	number
totalPages	number

---

TConsumerMessageHandler

Ƭ TConsumerMessageHandler: (msg: IConsumableMessage, cb: ICallback<void>) => void

Type declaration

▸ (msg, cb): void

Parameters

Name	Type
msg	IConsumableMessage
cb	ICallback<void>

Returns

void

---

TConsumerRedisKeys

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

---

TEventListenersConfig

Ƭ TEventListenersConfig: () => IEventListener[]

---

TExchange

Ƭ TExchange: ExchangeDirect | ExchangeTopic | ExchangeFanOut

---

TExchangeDirectBindingParams

Ƭ TExchangeDirectBindingParams: IQueueParams | string

---

TExchangeFanOutBindingParams

Ƭ TExchangeFanOutBindingParams: string

---

TExchangeSerialized

Ƭ TExchangeSerialized: ReturnType<ExchangeDirect["toJSON"]> | ReturnType<ExchangeTopic["toJSON"]> | ReturnType<ExchangeFanOut["toJSON"]>

---

TExchangeTopicBindingParams

Ƭ TExchangeTopicBindingParams: TTopicParams | string

---

TMessageConsumeOptions

Ƭ TMessageConsumeOptions: Object

Type declaration

Name	Type
consumeTimeout	number
retryDelay	number
retryThreshold	number
ttl	number

---

TQueueConsumer

Ƭ TQueueConsumer: Object

Type declaration

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

---

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

• TEvent

  ↳ TRedisSMQEvent.

Ƭ TRedisSMQEvent

Event Name	Arguments
heartbeatTick	(timestamp: number, consumerId: string, heartbeatPayload: IConsumerHeartbeat) => void ;
messageAcknowledged	(messageId: string, queue: IQueueParams, messageHandlerId: string, consumerId: string) => void ;
messageDeadLettered	(messageId: string, queue: IQueueParams, messageHandlerId: string, consumerId: string, cause: EConsumeMessageDeadLetterCause) => void ;
messageDelayed	(messageId: string, queue: IQueueParams, messageHandlerId: string, consumerId: string) => void ;
messagePublished	(messageId: string, queue: IQueueParams, producerId: string) => void ;
messageReceived	(messageId: string, queue: IQueueParams, consumerId: string) => void ;
messageRequeued	(messageId: string, queue: IQueueParams, messageHandlerId: string, consumerId: string) => void ;
messageUnacknowledged	(messageId: string, queue: IQueueParams, messageHandlerId: string, consumerId: string, cause: EConsumeMessageUnacknowledgedCause) => void ;

---

TTopicParams

Ƭ TTopicParams: Object

Type declaration

Name	Type
ns	string
topic	string

Functions

disconnect

▸ disconnect(cb): void

Parameters

Name	Type
cb	ICallback<void>

Returns

void