QueueMessages.md

RedisSMQ / Docs / API Reference / QueueMessages

Class: QueueMessages

Hierarchy

• QueueMessagesPaginatorSet

  ↳ QueueMessages

Table of contents

Constructors

• constructor

Methods

• countMessages
• countMessagesByStatus
• getMessages
• purge
• shutdown

Constructors

constructor

• new QueueMessages(): QueueMessages

Returns

QueueMessages

Overrides

QueueMessagesPaginatorSet.constructor

Methods

countMessages

▸ countMessages(queue, cb): void

Parameters

Name	Type
queue	TQueueExtendedParams
cb	ICallback<number>

Returns

void

Inherited from

QueueMessagesPaginatorSet.countMessages

---

countMessagesByStatus

▸ countMessagesByStatus(queue, cb): void

Parameters

Name	Type
queue	string | IQueueParams
cb	ICallback<IQueueMessagesCount>

Returns

void

---

getMessages

▸ getMessages(queue, page, pageSize, cb): void

Parameters

Name	Type
queue	TQueueExtendedParams
page	number
pageSize	number
cb	ICallback<IQueueMessagesPage<IMessageTransferable>>

Returns

void

Inherited from

QueueMessagesPaginatorSet.getMessages

---

purge

▸ purge(queue, cb): void

Parameters

Name	Type
queue	TQueueExtendedParams
cb	ICallback<void>

Returns

void

Inherited from

QueueMessagesPaginatorSet.purge

---

shutdown

▸ shutdown(cb): void

Parameters

Name	Type
cb	ICallback<void>

Returns

void

Overrides

QueueMessagesPaginatorSet.shutdown