Class FileFlinger

FileFlinger class Allows to create a file processing service that can be used to watch a folder for new files and send them to a destination (S3, FTP, ...) using pushers. The service can be configured with a pattern to match the file names and generate keys for the destination. Once a file is processed, it can be moved to an archive folder (zipped optionally) or deleted. As a @mdf.js service, it offer prometheus metrics, health checks, and logging.

Hierarchy

  • EventEmitter
    • FileFlinger

Implements

Constructors

constructor

Properties

componentId name

Accessors

checks metrics status

Methods

close start stop

Events

on

Constructors

constructor

Properties

ReadonlycomponentId

componentId: string = ...

The component identifier

Readonlyname

name: string

The name of the instance of the FileFlinger

Accessors

checks

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">

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>

start

  • start(): Promise<void>

  • Start the file flinger

    Returns Promise<void>

stop

  • stop(): Promise<void>

  • Stop the file flinger

    Returns Promise<void>

Events

on

  • on(event: "error", listener: (error: Crash | Multi | Error) => void): this

  • Add a listener for the error event, emitted when the component detects an error.

    Parameters

    • event: "error"

      error event

    • listener: (error: Crash | Multi | Error) => void

      Error event listener

    Returns this

  • on(event: "status", listener: (status: "pass" | "fail" | "warn") => void): this

  • Add a listener for the status event, emitted when the component status changes.

    Parameters

    • event: "status"

      status event

    • listener: (status: "pass" | "fail" | "warn") => void

      Status event listener

    Returns this

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
Events