Class FileHandler

constructor

• new FileHandler(
      name: string,
      options: FileHandlerOptions,
      logger: LoggerInstance,
  ): FileHandler

• Creates a new instance of the file manager

  Parameters

  • name: string

    Service name
  • options: FileHandlerOptions

    Service setup options
  • logger: LoggerInstance

    Logger instance

  Returns FileHandler

Readonlyname

Readonlyoptions

rotationScheduled

Readonlystats

append

• append(data: string): Promise<void>

• Appends data to the file store. This method uses the Limiter to ensure only one file operation is executed at a time (concurrency=1) and to retry the append operation if necessary

  Parameters

  • data: string

    The data to append to the file.

  Returns Promise<void>

  A promise that resolves when the append operation is complete.

close

• close(): Promise<void>

• Closes the current file stream.

  Returns Promise<void>

  A promise that resolves when the file stream is closed.

on

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

• Add a listener for the error event, emitted when there is an error in a file handler operation.

  Parameters

  • event: "error"

    error event
  • listener: (error: Crash) => void

    Error event listener

  Returns this
• on(event: "rotate", listener: (stats: FileStats) => void): this

• Add a listener for the rotate event, emitted when a file is rotated.

  Parameters

  • event: "rotate"

    error event
  • listener: (stats: FileStats) => void

    Error event listener

  Returns this
• on(event: "resolve", listener: (stats: FileStats) => void): this

• Add a listener for the resolve event, emitted when an operation is resolved.

  Parameters

  • event: "resolve"

    resolve event
  • listener: (stats: FileStats) => void

    Resolve event listener

  Returns this