• Function

    getHealthStatus

    Returns a deterministic health payload useful for smoke tests and service availability checks. The response includes a status indicator, message, and ISO 8601 timestamp.

    Returns

    Health status payload with ok=true, provided message, and current timestamp

    Example

    const health = getHealthStatus();
    // { ok: true, message: 'library-ready', timestamp: '2026-05-12T...' }

    Example

    const customHealth = getHealthStatus('all-systems-nominal');
    // { ok: true, message: 'all-systems-nominal', timestamp: '2026-05-12T...' }

    Author

    Bayu Dwiyan Satria

    Since

    1.0.0

    Parameters

    • Optional message: string = 'library-ready'

      Custom health status message

    Returns HealthStatus

Generated using TypeDoc