Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Status

Represents the outcome of a health check procedure. Each procedure produces a Status indicating either OK or KO. Optionally, it can also provide additional data.

Hierarchy

  • Status

Index

Constructors

Methods

Constructors

constructor

  • Returns Status

  • Parameters

    Returns Status

Methods

getData

  • getData(): {}

  • Sets the metadata.

    Returns {}

    • [key: string]: any

isOk

  • isOk(): boolean

  • Sets whether or not the current status is positive (UP) or negative (DOWN).

    Returns boolean

isProcedureInError

  • isProcedureInError(): boolean

  • Sets whether or not the procedure attached to this status has failed (timeout, error...).

    Returns boolean

setData

  • Sets the metadata.

    Parameters

    • data: {}
      • [key: string]: any

    Returns Status

setOk

  • Sets whether or not the current status is positive (UP) or negative (DOWN).

    Parameters

    • ok: boolean

    Returns Status

setProcedureInError

  • setProcedureInError(procedureInError: boolean): Status

  • Sets whether or not the procedure attached to this status has failed (timeout, error...).

    Parameters

    • procedureInError: boolean

    Returns Status

toJson

  • toJson(): {}

  • Returns {}

    • [key: string]: any

Generated using TypeDoc