Class Queue<Data>

Type parameters

Data

Hierarchy

Queue

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Queue(name: string, channel: Channel<Data>, options: QueueOptions): Queue

- Defined in lib/Queue.ts:17
Parameters
- name: string
- channel: Channel<Data>
- options: QueueOptions
Returns Queue

Properties

channel

channel: Channel<Data>

logger

logger: LoggerInstance

name

name: string

options

options: QueueOptions

Methods

assert

assert(): Promise<AssertQueue>

- Defined in lib/Queue.ts:50
Assert queue in the channel.

Returns Promise<AssertQueue>

bind

bind(): Promise<void>

- Defined in lib/Queue.ts:30
Returns Promise<void>

publish

publish(data: Data, options?: AMQPOptions.Publish): Promise<boolean>

- Defined in lib/Queue.ts:57
Publishes data to queue.

Parameters
- data: Data
- Optional options: AMQPOptions.Publish
Returns Promise<boolean>

subscribe

subscribe(onData: QueueSubscriber<Data>, options?: AMQPOptions.Consume): void

- Defined in lib/Queue.ts:64
Subscribes to queue messages.

Parameters
- onData: QueueSubscriber<Data>
- Optional options: AMQPOptions.Consume
Returns void

Static from

from<Data>(name: string, channel: Channel<Data>, options: QueueOptions): Promise<Queue<Data>>

- Defined in lib/Queue.ts:24
Type parameters
- Data
Parameters
- name: string
- channel: Channel<Data>
- options: QueueOptions
Returns Promise<Queue<Data>>

Generated using TypeDoc