Package Exports

@breadstone/archipel-platform-health
@breadstone/archipel-platform-health/src/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@breadstone/archipel-platform-health) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@breadstone/archipel-platform-health

Health check orchestration for NestJS applications built on top of @nestjs/terminus.

Features

Indicator-based architecture — Implement IHealthIndicator for each subsystem
Aggregated checks — HealthOrchestrator.check() runs all registered indicators
Terminus integration — Built on @nestjs/terminus for standard health endpoints
Declarative registration — HealthModule.withIndicators() for module-level setup

Quick Start

import { HealthModule, HealthOrchestrator, IHealthIndicator } from '@breadstone/archipel-platform-health';

class DatabaseHealthIndicator implements IHealthIndicator {
  public readonly name = 'database';

  public async isHealthy(): Promise<IHealthCheckResult> {
    return { status: 'up' };
  }
}

@Module({
  imports: [HealthModule.withIndicators([DatabaseHealthIndicator])],
})
export class AppModule {}

Resource Limits

Limit	Value	Description
Max indicators	100	`HealthOrchestrator` rejects registrations beyond 100

Peer Dependencies

Package	Required	Notes
`@nestjs/common`	Yes	NestJS core
`@nestjs/terminus`	Yes	Health check framework

Documentation

📖 Package Docs: .docs/packages/platform-health/index.md

Development

# Build
yarn nx build platform-health

# Test
yarn nx test platform-health

# Lint
yarn nx lint platform-health