Class Result

constructor

• new Result(
      message: string,
      status: "ok" | "warning" | "error",
      finishedAt: Date,
  ): Result

  Creates a new Result instance

  Parameters

  • message: string

    The result message

  • status: "ok" | "warning" | "error"

    The result status

  • finishedAt: Date

    The timestamp when the check finished

  Returns Result

Optionalmeta

message

status

finishedAt

Staticok

• ok(message: string): Result

  Create result for success status

  Parameters

  • message: string

    The success message

  Returns Result

  Example

  const result = Result.ok('Database connection is healthy')
  Copy

Staticfailed

• failed(message: string, error?: Error): Result

  Create result for failed status

  Parameters

  • message: string

    The error message or Error object

  • Optionalerror: Error

    Optional error object when message is a string

  Returns Result

  Example

  const result1 = Result.failed('Database connection failed')
  const result2 = Result.failed('Service error', new Error('Connection timeout'))
  const result3 = Result.failed(new Error('Critical failure'))
  Copy

• failed(error: Error): Result

  Create result for failed status

  Parameters

  • error: Error

    Optional error object when message is a string

  Returns Result

  Example

  const result1 = Result.failed('Database connection failed')
  const result2 = Result.failed('Service error', new Error('Connection timeout'))
  const result3 = Result.failed(new Error('Critical failure'))
  Copy

Staticwarning

• warning(message: string): Result

  Create result for warning status

  Parameters

  • message: string

    The warning message

  Returns Result

  Example

  const result = Result.warning('Memory usage is above 80%')
  Copy

setFinishedAt

• setFinishedAt(finishedAt: Date): Result

  Update the finished at timestamp for the result

  Parameters

  • finishedAt: Date

    The new finish timestamp

  Returns Result

  Example

  const result = Result.ok('Check completed')
    .setFinishedAt(new Date('2024-01-01T10:00:00Z'))
  Copy

setMetaData

• setMetaData(metaData: Record<string, any>): Result

  Define custom meta-data for the result. Calling this method will override the existing meta-data

  Parameters

  • metaData: Record<string, any>

    The metadata object to set

  Returns Result

  Example

  const result = Result.ok('Service is healthy')
    .setMetaData({ responseTime: 120, uptime: 86400 })
  Copy

mergeMetaData

• mergeMetaData(metaData: Record<string, any>): Result

  Merge custom meta-data with the existing meta-data. A shallow merge is performed

  Parameters

  • metaData: Record<string, any>

    The metadata object to merge

  Returns Result

  Example

  const result = Result.ok('Service is healthy')
    .setMetaData({ responseTime: 120 })
    .mergeMetaData({ uptime: 86400 })
  // result.meta = { responseTime: 120, uptime: 86400 }
  Copy

toJSON

• toJSON(): HealthCheckResult

  Convert the result to a plain object

  Returns HealthCheckResult

  Example

  const result = Result.ok('Service is healthy')
  const json = result.toJSON()
  console.log(json) // { message: 'Service is healthy', status: 'ok', finishedAt: Date }
  Copy