@rxap/nest-amqp
Version:
@rxap/nest-amqp
76 lines (38 loc) • 1.54 kB
Markdown
[**@rxap/nest-amqp**](../README.md)
***
[@rxap/nest-amqp](../globals.md) / AmqpHealthIndicator
# Class: AmqpHealthIndicator
Defined in: [packages/nest/amqp/src/lib/amqp.health-indicator.ts:10](https://gitlab.com/rxap/libraries/cqrs/-/blob/b3efc64bb3a298aa043affe1613958c91a6aac2f/packages/nest/amqp/src/lib/amqp.health-indicator.ts#L10)
## Extends
- `HealthIndicator`
## Constructors
### new AmqpHealthIndicator()
> **new AmqpHealthIndicator**(): [`AmqpHealthIndicator`](AmqpHealthIndicator.md)
#### Returns
[`AmqpHealthIndicator`](AmqpHealthIndicator.md)
#### Inherited from
`HealthIndicator.constructor`
## Methods
### getStatus()
> `protected` **getStatus**(`key`, `isHealthy`, `data`?): `HealthIndicatorResult`
Defined in: node\_modules/@nestjs/terminus/dist/health-indicator/health-indicator.d.ts:35
Generates the health indicator result object
#### Parameters
##### key
`string`
The key which will be used as key for the result object
##### isHealthy
`boolean`
Whether the health indicator is healthy
##### data?
Additional data which will get appended to the result object
#### Returns
`HealthIndicatorResult`
#### Inherited from
`HealthIndicator.getStatus`
***
### isHealthy()
> **isHealthy**(): `Promise`\<`HealthIndicatorResult`\>
Defined in: [packages/nest/amqp/src/lib/amqp.health-indicator.ts:17](https://gitlab.com/rxap/libraries/cqrs/-/blob/b3efc64bb3a298aa043affe1613958c91a6aac2f/packages/nest/amqp/src/lib/amqp.health-indicator.ts#L17)
#### Returns
`Promise`\<`HealthIndicatorResult`\>