Class: AmqpConnection

Defined in: packages/rabbitmq/src/amqp/connection.ts:124

Accessors

channel

Get Signature

get channel(): ConfirmChannel;

Defined in: packages/rabbitmq/src/amqp/connection.ts:165

Returns

ConfirmChannel

---

channels

Get Signature

get channels(): Record<string, ConfirmChannel>;

Defined in: packages/rabbitmq/src/amqp/connection.ts:187

Returns

Record<string, ConfirmChannel>

---

configuration

Get Signature

get configuration(): Required<RabbitMQConfig>;

Defined in: packages/rabbitmq/src/amqp/connection.ts:183

Returns

Required<RabbitMQConfig>

---

connected

Get Signature

get connected(): boolean;

Defined in: packages/rabbitmq/src/amqp/connection.ts:195

Returns

boolean

---

connection

Get Signature

get connection(): Connection;

Defined in: packages/rabbitmq/src/amqp/connection.ts:170

Returns

Connection

---

consumerTags

Get Signature

get consumerTags(): string[];

Defined in: packages/rabbitmq/src/amqp/connection.ts:1198

Returns

string[]

---

managedChannel

Get Signature

get managedChannel(): ChannelWrapper;

Defined in: packages/rabbitmq/src/amqp/connection.ts:175

Returns

ChannelWrapper

---

managedChannels

Get Signature

get managedChannels(): Record<string, ChannelWrapper>;

Defined in: packages/rabbitmq/src/amqp/connection.ts:191

Returns

Record<string, ChannelWrapper>

---

managedConnection

Get Signature

get managedConnection(): IAmqpConnectionManager;

Defined in: packages/rabbitmq/src/amqp/connection.ts:179

Returns

IAmqpConnectionManager

Constructors

Constructor

new AmqpConnection(config): AmqpConnection;

Defined in: packages/rabbitmq/src/amqp/connection.ts:153

Parameters

Parameter	Type
config	RabbitMQConfig

Returns

AmqpConnection

Methods

cancelConsumer()

cancelConsumer(consumerTag): Promise<void>;

Defined in: packages/rabbitmq/src/amqp/connection.ts:1202

Parameters

Parameter	Type
consumerTag	string

Returns

Promise<void>

---

close()

close(): Promise<void>;

Defined in: packages/rabbitmq/src/amqp/connection.ts:1250

Returns

Promise<void>

---

createBatchSubscriber()

createBatchSubscriber<T>(
   handler, 
   msgOptions, 
   consumeOptions?
): Promise<SubscriptionResult>;

Defined in: packages/rabbitmq/src/amqp/connection.ts:488

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
handler	BatchSubscriberHandler<T>
msgOptions	MessageHandlerOptions
consumeOptions?	Consume

Returns

Promise<SubscriptionResult>

---

createRpc()

createRpc<T, U>(handler, rpcOptions): Promise<SubscriptionResult>;

Defined in: packages/rabbitmq/src/amqp/connection.ts:808

Type Parameters

Type Parameter
T
U

Parameters

Parameter	Type
handler	RpcSubscriberHandler<T, U>
rpcOptions	MessageHandlerOptions

Returns

Promise<SubscriptionResult>

---

createSubscriber()

createSubscriber<T>(
   handler, 
   msgOptions, 
   originalHandlerName, 
   consumeOptions?
): Promise<SubscriptionResult>;

Defined in: packages/rabbitmq/src/amqp/connection.ts:467

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
handler	SubscriberHandler<T>
msgOptions	MessageHandlerOptions
originalHandlerName	string
consumeOptions?	Consume

Returns

Promise<SubscriptionResult>

---

init()

init(): Promise<void>;

Defined in: packages/rabbitmq/src/amqp/connection.ts:199

Returns

Promise<void>

---

publish()

publish(
   exchange, 
   routingKey, 
   message, 
   options?
): Promise<boolean>;

Defined in: packages/rabbitmq/src/amqp/connection.ts:993

Parameters

Parameter	Type
exchange	string
routingKey	string
message	unknown
options?	Publish

Returns

Promise<boolean>

---

request()

request<T>(requestOptions): Promise<T>;

Defined in: packages/rabbitmq/src/amqp/connection.ts:420

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
requestOptions	RequestOptions

Returns

Promise<T>

---

resumeConsumer()

resumeConsumer<T, U>(consumerTag): Promise<string | null>;

Defined in: packages/rabbitmq/src/amqp/connection.ts:1213

Type Parameters

Type Parameter
T
U

Parameters

Parameter	Type
consumerTag	string

Returns

Promise<string | null>

---

setupRpcChannel()

setupRpcChannel<T, U>(
   handler, 
   rpcOptions, 
   channel
): Promise<string>;

Defined in: packages/rabbitmq/src/amqp/connection.ts:869

Type Parameters

Type Parameter
T
U

Parameters

Parameter	Type
handler	RpcSubscriberHandler<T, U>
rpcOptions	MessageHandlerOptions
channel	ConfirmChannel

Returns

Promise<string>