File

src/application/controller/health.controller.ts

Prefix

health

Description

Health controller class

Index

Methods

Methods

check
check()
Decorators :
@Get()
@HealthCheck()

Checks the liveness of the project

Returns : { status: string; info: { alive: { status: string; }; }; error: {}; details: { alive: { status: string; }; }; }

http response

import { Controller, Get } from '@nestjs/common';
import { HealthCheckService, HttpHealthIndicator, HealthCheck } from '@nestjs/terminus';
/**
 * Health controller class
 */
@Controller('health')
export class HealthController {
  /**
   * Health check controller class constructor.
   * @param health health check service
   * @param http http response
   */
  constructor(private health: HealthCheckService, private http: HttpHealthIndicator) {}
  //======================================================================================================
  /**
   * Checks the liveness of the project
   * @returns http response
   */
  @Get()
  @HealthCheck()
  check() {
    return { status: 'ok', info: { alive: { status: 'up' } }, error: {}, details: { alive: { status: 'up' } } };
  }
}

results matching ""

    No results matching ""