@nestjs/terminus/dist/health-indicator/database/prisma.health.d.ts

Terminus integration provides readiness/liveness health checks for NestJS.

import { type HealthIndicatorResult } from '../health-indicator-result.interface';
import { HealthIndicatorService } from '../health-indicator.service';
type PingCommandSignature = {
    [Key in string]?: number;
};
type PrismaClientDocument = {
    $runCommandRaw: (command: PingCommandSignature) => any;
};
type PrismaClientSQL = {
    $queryRawUnsafe: (query: string) => any;
};
type PrismaClient = PrismaClientDocument | PrismaClientSQL;
export interface PrismaClientPingCheckSettings {
    /**
     * The amount of time the check should require in ms
     */
    timeout?: number;
}
/**
 * The PrismaHealthIndicator contains health indicators
 * which are used for health checks related to Prisma
 *
 * @publicApi
 * @module TerminusModule
 */
export declare class PrismaHealthIndicator {
    private readonly healthIndicatorService;
    constructor(healthIndicatorService: HealthIndicatorService);
    private pingDb;
    /**
     * Checks if the Prisma responds in (default) 1000ms and
     * returns a result object corresponding to the result
     *
     * @param key The key which will be used for the result object
     * @param prismaClient PrismaClient
     * @param options The options for the ping
     */
    pingCheck<Key extends string = string>(key: Key, prismaClient: PrismaClient, options?: PrismaClientPingCheckSettings): Promise<HealthIndicatorResult<Key>>;
}
export {};