lib/health-indicators/database/typeorm.health.ts

The TypeOrmHealthIndicator contains health indicators which are used for health checks related to TypeOrm

constructor(moduleRef: ModuleRef)

Initializes the TypeOrmHealthIndicator

Parameters :

Name	Type	Optional	Description
moduleRef	`ModuleRef`	No	`The NestJS module reference`

Async pingCheck

pingCheck(key: string, options: TypeOrmPingCheckSettings)

Checks if responds in (default) 1000ms and returns a result object corresponding to the result

Parameters :

Name	Type	Optional	Default value	Description
key	`string`	No		The key which will be used for the result object
options	`TypeOrmPingCheckSettings`	No	`{}`	The options for the ping

Example :

typeOrmHealthIndicator.pingCheck(&#39;database&#39;, { timeout: 1500 });

Returns : Promise<HealthIndicatorResult>

Protected getStatus

getStatus(key: string, isHealthy: boolean, data?: literal type)

Generates the health indicator result object

Parameters :

Name	Type	Optional	Description
key	`string`	No	The key which will be used as key for the result object
isHealthy	`boolean`	No	Whether the health indicator is healthy
data	`literal type`	Yes	Additional data which will get appended to the result object

Returns : HealthIndicatorResult

result-matching ""

No results matching ""