Class LogFile<T>

constructor

• new LogFile<T>(filepath): LogFile<T>

• Creates a new instance of the LogFile class.

  Type Parameters

  • T

  Parameters

  • filepath: string

    The path to the log file.

  Returns LogFile<T>

filepath

append

• append(data, time?): Promise<void>

• Appends a log entry to the log file.

  Parameters

  • data: T

    The data to be logged.

  • time: number = ...

    The timestamp of the log entry. Defaults to the current time.

  Returns Promise<void>

  A promise that resolves when the log entry is appended.

ensureDirectoryExists

• ensureDirectoryExists(): void

• Ensures that the directory containing the log file exists.

  Returns void

entries

• entries(): AsyncGenerator<[number, T], any, unknown>

• Returns an async generator that yields the entries (timestamp and value) of log entries in the log file.

  Returns AsyncGenerator<[number, T], any, unknown>

  Yields

  The entries (timestamp and value) of log entries.

keys

• keys(): AsyncGenerator<number, any, unknown>

• Returns an async generator that yields the timestamps of log entries in the log file.

  Returns AsyncGenerator<number, any, unknown>

  Yields

  The timestamps of log entries.

readFile

• readFile(): [number, T][]

• Reads the log entire file and returns an array of log entries, sorted by timestamp in descending order.

  Returns [number, T][]

  An array of log entries, sorted by timestamp in descending order.

reset

• reset(): void

• Resets the log file by removing it.

  Returns void

values

• values(): AsyncGenerator<T, any, unknown>

• Returns an async generator that yields the values of log entries in the log file.

  Returns AsyncGenerator<T, any, unknown>

  Yields

  The values of log entries.