Class Queue

Abstraction over AMQP queue operations on a Channel.

Hierarchy

Queue

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Queue(channel: Channel, name: string): Queue

- Defined in src/queue.ts:21
Parameters
- channel: Channel
  
  AMQP channel from amqplib
- name: string
  
  Queue name
Returns Queue

Properties

Private #channel

#channel: Channel

Private #name

#name: string

Methods

bind

bind(source: string, pattern: string, args?: any): Promise<void>

- Defined in src/queue.ts:64
Route message from an exchange to this queue.

Will call Channel.bindQueue.

Parameters
- source: string
- pattern: string
- Optional args: any
Returns Promise<void>

check

check(): Promise<AssertQueue>

- Defined in src/queue.ts:37
Check whether this queue exists.

Will call Channel.checkQueue.

Returns Promise<AssertQueue>

purge

purge(): Promise<PurgeQueue>

- Defined in src/queue.ts:55
Purge messages from this queue.

Will call Channel.purgeQueue.

Returns Promise<PurgeQueue>

remove

remove(options: DeleteQueue): Promise<DeleteQueue>

- Defined in src/queue.ts:46
Delete this queue.

Will call Channel.deleteQueue.

Parameters
- options: DeleteQueue
Returns Promise<DeleteQueue>

unbind

unbind(source: string, pattern: string, args?: any): Promise<void>

- Defined in src/queue.ts:73
Remove the route from an exchange to this queue.

Will call Channel.unbindQueue.

Parameters
- source: string
- pattern: string
- Optional args: any
Returns Promise<void>

Generated using TypeDoc