Class FilePrinter

A logger printer that writes log records to a file, with support for log rotation based on file size or age.

Implements

ILoggerPrinter

Index

Constructors

Methods

clear close flush print

Constructors

constructor

new FilePrinter(filePath: string, options?: FilePrinterOptions): FilePrinter
Creates a new FilePrinter instance.
Parameters
- filePath: string
  The path to the log file.
- Optionaloptions: FilePrinterOptions
  Optional settings for the file printer.
Returns FilePrinter
- Defined in logger/printers/file-printer.ts:76

Methods

clear

clear(): Promise<void>
This method is a no-op for FilePrinter.

Returns Promise<void>
Implementation of ILoggerPrinter.clear
- Defined in logger/printers/file-printer.ts:107

close

close(): Promise<void>
Closes the file printer, ensuring all pending log records are flushed and the file stream is properly closed.

Returns Promise<void>
Implementation of ILoggerPrinter.close
- Defined in logger/printers/file-printer.ts:87

flush

flush(): Promise<void>
Flushes any buffered log records to the file.

Returns Promise<void>
Implementation of ILoggerPrinter.flush
- Defined in logger/printers/file-printer.ts:98

print

print(record: LoggerRecord): Promise<void>
Prints a log record to the file.
Parameters
- record: LoggerRecord
  The log record to print.
Returns Promise<void>
Implementation of ILoggerPrinter.print
- Defined in logger/printers/file-printer.ts:118