PrismaHealthIndicator

The PrismaHealthIndicator contains health indicators which are used for health checks related to Prisma

  
class PrismaHealthIndicator {
  pingCheck<Key extends string = string>(key: Key, prismaClient: PrismaClient, options: PrismaClientPingCheckSettings = {}): Promise<HealthIndicatorResult<Key>>
}

Methods

pingCheck()

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


pingCheck<Key extends string = string>(key: Key, prismaClient: PrismaClient, options: PrismaClientPingCheckSettings = {}): Promise<HealthIndicatorResult<Key>>

Parameters

Option Type Description
key Key

The key which will be used for the result object

prismaClient PrismaClient

PrismaClient

options PrismaClientPingCheckSettings

The options for the ping


Optional. Default is `{}`.

Returns

Promise<HealthIndicatorResult<Key>>