Class: RabbitMQModule

Defined in: packages/rabbitmq/src/rabbitmq.module.ts:125

Constructors

Constructor

new RabbitMQModule(): RabbitMQModule;

Returns

RabbitMQModule

Methods

AmqpConnectionFactory()

static AmqpConnectionFactory(config): Promise<AmqpConnection | undefined>;

Defined in: packages/rabbitmq/src/rabbitmq.module.ts:165

Parameters

Parameter	Type
config	RabbitMQConfig

Returns

Promise<AmqpConnection | undefined>

---

attach()

static attach(connection): DynamicModule;

Defined in: packages/rabbitmq/src/rabbitmq.module.ts:277

Parameters

Parameter	Type
connection	AmqpConnection

Returns

DynamicModule

---

forFeature()

static forFeature(handlers): DynamicModule;

Defined in: packages/rabbitmq/src/rabbitmq.module.ts:269

Parameters

Parameter	Type
handlers	unknown[]

Returns

DynamicModule

---

forRoot()

static forRoot(options): DynamicModule;

Defined in: packages/rabbitmq/src/rabbitmq.module.ts:187

Parameters

Parameter	Type
options	RabbitMQModuleOptions

Returns

DynamicModule

---

forRootAsync()

static forRootAsync(options): DynamicModule;

Defined in: packages/rabbitmq/src/rabbitmq.module.ts:222

Parameters

Parameter	Type
options	{ inject?: ( | ProviderToken | { optional?: boolean; token: ProviderToken; })[]; isGlobal?: boolean; useFactory: (...args) => | RabbitMQModuleOptions | Promise<RabbitMQModuleOptions>; }
options.inject?	( | ProviderToken | { optional?: boolean; token: ProviderToken; })[]
options.isGlobal?	boolean
options.useFactory	(...args) => | RabbitMQModuleOptions | Promise<RabbitMQModuleOptions>

Returns

DynamicModule

---

markConnectionBootstrapped()

static markConnectionBootstrapped(name): boolean;

Defined in: packages/rabbitmq/src/rabbitmq.module.ts:148

Internal

Marks a connection as bootstrapped. Returns true when it was already bootstrapped (the caller should skip re-registration) and false on the first call for that connection name.

Parameters

Parameter	Type
name	string

Returns

boolean

---

resetBootstrapGuard()

static resetBootstrapGuard(): void;

Defined in: packages/rabbitmq/src/rabbitmq.module.ts:161

Internal

Clears the per-connection bootstrap guard. Called on shutdown so a subsequent boot (e.g. across test suites) re-registers handlers.

Returns

void

Properties

Property	Modifier	Type	Description	Defined in
connectionManager	readonly	AmqpConnectionManager	Shared manager that owns every named connection created through this module. Kept static so that multiple forRoot/forRootAsync registrations (one per named connection) share a single registry, and so the shutdown hook can close them all.	packages/rabbitmq/src/rabbitmq.module.ts:132