Class RegisterFacade

The RegisterFacade class provides a centralized solution for error monitoring across all components of an application. It acts as a facade over various underlying mechanisms to facilitate error aggregation, error information exposure through REST APIs, and error registry management.

It integrates with:

  • Port: To handle inter-process communication for error information in clustered environments, distinguishing between master and worker processes.
  • Aggregator: To aggregate error information from different components of the application.

This class also provides a REST API endpoint for accessing collected error information and supports operations for registering errors and clearing the error registry.

Hierarchy

  • EventEmitter
    • RegisterFacade

Implements

Constructors

constructor

Accessors

checks componentId errors lastUpdate links name router size status

Methods

clear close push register start stop

Constructors

constructor

Accessors

checks

componentId

  • get componentId(): string

  • Returns string

    The application identifier

errors

lastUpdate

  • get lastUpdate(): string

  • Returns string

    Last update date

links

  • Returns { [link: string]: string }

    Links offered by this service

name

  • get name(): string

  • Returns string

    The application name

router

  • get router(): Router

  • Returns Router

    An Express router with access to registered errors

size

  • get size(): number

  • Returns number

    The current number of registered errors

status

  • get status(): "pass" | "fail" | "warn"

  • Returns "pass" | "fail" | "warn"

    The health status of the component

Methods

clear

  • clear(): void

  • Clear the error registry

    Returns void

close

  • close(): Promise<void>

  • Closes the error registry service, performing cleanup actions as necessary.

    Returns Promise<void>

push

  • push(error: HandleableError): void

  • Adds an error to the registry, converting it to a structured format.

    Parameters

    Returns void

register

  • register(component: Observable | Observable[]): void

  • Registers one or multiple components to be monitored.

    Parameters

    Returns void

start

  • start(): Promise<void>

  • Starts the error registry service, including the communication port and error event listeners.

    Returns Promise<void>

stop

  • stop(): Promise<void>

  • Stops the error registry service, including halting communication and removing event listeners.

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods