@rxap/nest-amqp
Version:
@rxap/nest-amqp
104 lines (52 loc) • 3.26 kB
Markdown
[**/nest-amqp**](../README.md)
***
[/nest-amqp](../globals.md) / AmqpOptionsFactory
# Class: AmqpOptionsFactory
Defined in: [packages/nest/amqp/src/lib/amqp-options.factory.ts:14](https://gitlab.com/rxap/libraries/cqrs/-/blob/b3efc64bb3a298aa043affe1613958c91a6aac2f/packages/nest/amqp/src/lib/amqp-options.factory.ts#L14)
## Implements
- `ConfigurableModuleOptionsFactory`\<[`AmqpOptions`](../interfaces/AmqpOptions.md), `"create"`\>
## Constructors
### new AmqpOptionsFactory()
> **new AmqpOptionsFactory**(): [`AmqpOptionsFactory`](AmqpOptionsFactory.md)
#### Returns
[`AmqpOptionsFactory`](AmqpOptionsFactory.md)
## Properties
### config
> `protected` `readonly` **config**: `ConfigService`
Defined in: [packages/nest/amqp/src/lib/amqp-options.factory.ts:18](https://gitlab.com/rxap/libraries/cqrs/-/blob/b3efc64bb3a298aa043affe1613958c91a6aac2f/packages/nest/amqp/src/lib/amqp-options.factory.ts#L18)
***
### logger
> `protected` `readonly` **logger**: `Logger`
Defined in: [packages/nest/amqp/src/lib/amqp-options.factory.ts:21](https://gitlab.com/rxap/libraries/cqrs/-/blob/b3efc64bb3a298aa043affe1613958c91a6aac2f/packages/nest/amqp/src/lib/amqp-options.factory.ts#L21)
## Methods
### buildUrl()
> **buildUrl**(): `Promise`\<`string`\>
Defined in: [packages/nest/amqp/src/lib/amqp-options.factory.ts:78](https://gitlab.com/rxap/libraries/cqrs/-/blob/b3efc64bb3a298aa043affe1613958c91a6aac2f/packages/nest/amqp/src/lib/amqp-options.factory.ts#L78)
#### Returns
`Promise`\<`string`\>
***
### create()
> **create**(): `Promise`\<[`AmqpOptions`](../interfaces/AmqpOptions.md)\>
Defined in: [packages/nest/amqp/src/lib/amqp-options.factory.ts:23](https://gitlab.com/rxap/libraries/cqrs/-/blob/b3efc64bb3a298aa043affe1613958c91a6aac2f/packages/nest/amqp/src/lib/amqp-options.factory.ts#L23)
#### Returns
`Promise`\<[`AmqpOptions`](../interfaces/AmqpOptions.md)\>
#### Implementation of
`ConfigurableModuleOptionsFactory.create`
***
### getCredentials()
> **getCredentials**(): `Promise`\<`null` \| \{ `password`: `string`; `username`: `string`; \}\>
Defined in: [packages/nest/amqp/src/lib/amqp-options.factory.ts:63](https://gitlab.com/rxap/libraries/cqrs/-/blob/b3efc64bb3a298aa043affe1613958c91a6aac2f/packages/nest/amqp/src/lib/amqp-options.factory.ts#L63)
#### Returns
`Promise`\<`null` \| \{ `password`: `string`; `username`: `string`; \}\>
***
### getExchange()
> **getExchange**(): `Promise`\<`undefined` \| [`ExchangeOptions`](../interfaces/ExchangeOptions-1.md)\>
Defined in: [packages/nest/amqp/src/lib/amqp-options.factory.ts:59](https://gitlab.com/rxap/libraries/cqrs/-/blob/b3efc64bb3a298aa043affe1613958c91a6aac2f/packages/nest/amqp/src/lib/amqp-options.factory.ts#L59)
#### Returns
`Promise`\<`undefined` \| [`ExchangeOptions`](../interfaces/ExchangeOptions-1.md)\>
***
### getQueue()
> **getQueue**(): `Promise`\<`undefined` \| [`QueueOptions`](../interfaces/QueueOptions.md)\>
Defined in: [packages/nest/amqp/src/lib/amqp-options.factory.ts:55](https://gitlab.com/rxap/libraries/cqrs/-/blob/b3efc64bb3a298aa043affe1613958c91a6aac2f/packages/nest/amqp/src/lib/amqp-options.factory.ts#L55)
#### Returns
`Promise`\<`undefined` \| [`QueueOptions`](../interfaces/QueueOptions.md)\>