Class Engine

A resource is extended component that represent the access to an external/internal resource, besides the error handling and identity, it has a start, stop and close methods to manage the resource lifecycle. It also has a checks property to define the checks that will be performed over the resource to achieve the resulted status. The most typical example of a resource are the Provider that allow to access to external databases, message brokers, etc.

Hierarchy

  • EventEmitter
    • Engine

Implements

Constructors

constructor

Accessors

checks componentId metrics name status

Methods

close processFile start stop

Constructors

constructor

Accessors

checks

componentId

  • get componentId(): string

  • Get the component identifier

    Returns string

metrics

  • get metrics(): Registry<"text/plain; version=0.0.4; charset=utf-8">

  • Return the metrics registry

    Returns Registry<"text/plain; version=0.0.4; charset=utf-8">

name

  • get name(): string

  • Get the name of the watcher

    Returns string

status

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

  • Overall component status

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

Methods

close

  • close(): Promise<void>

  • Close the file flinger

    Returns Promise<void>

processFile

  • processFile(filePath: string): Promise<void>

  • Add a file to the be processed

    Parameters

    • filePath: string

    Returns Promise<void>

start

  • start(): Promise<void>

  • Start the file flinger

    Returns Promise<void>

stop

  • stop(): Promise<void>

  • Stop the file flinger

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods