@nestjs/terminus/dist/health-indicator/disk/disk-health-options.type.d.ts

Terminus integration provides readiness/liveness health checks for NestJS.

import { type XOR } from '../../utils/types';
/**
 * @internal
 */
interface DiskOptionsBase {
    /**
     * The path which should get checked
     */
    path: string;
}
/**
 * @internal
 */
interface DiskOptionsThreshold {
    /**
     * The threshold in bytes
     */
    threshold: number;
}
/**
 * @internal
 */
interface DiskOptionsThresholdPercent {
    /**
     * The threshold in percent (e.g. 0.5)
     */
    thresholdPercent: number;
}
/**
 * @internal
 */
export type DiskOptionsWithThreshold = DiskOptionsBase & DiskOptionsThreshold;
/**
 * @internal
 */
export type DiskOptionsWithThresholdPercent = DiskOptionsBase & DiskOptionsThresholdPercent;
/**
 * The options of the disk health indicator
 * @publicApi
 */
export type DiskHealthIndicatorOptions = XOR<DiskOptionsWithThreshold, DiskOptionsWithThresholdPercent>;
export {};