Documents for @litert/xxl-job-integration / LogManagers/FileLogManager / FileLogCleaner

Class: FileLogCleaner

Defined in: src/lib/LogManagers/FileLogManager.ts:91

The cleaner for old log files in the specified directory.

This class periodically checks the log directory for files that are older than a specified maximum age, and removes them.

DON'T FORGET TO LISTEN ON THE error EVENT!

Events

• error

  When an error occurs during the registration or heartbeat process.

• cleaned

  When a log file is cleaned up.

Extends

• EventEmitter<IFileLogCleanerEvents>

Constructors

Constructor

new FileLogCleaner(opts): FileLogCleaner

Defined in: src/lib/LogManagers/FileLogManager.ts:103

Parameters

opts

IFileLogCleanerOptions

Returns

FileLogCleaner

Overrides

EventEmitter<IFileLogCleanerEvents>.constructor

Methods

start()

start(): void

Defined in: src/lib/LogManagers/FileLogManager.ts:117

Start the timer to clean up old log files periodically. If the timer is already running, this method does nothing.

Returns

void

---

stop()

stop(): void

Defined in: src/lib/LogManagers/FileLogManager.ts:133

Stop the timer that cleans up old log files. If the timer is not running, this method does nothing.

Returns

void