Class ArchiverManager

Class responsible of managing jsonl file store operations

Hierarchy

EventEmitter
- ArchiverManager

Index

Constructors

Accessors

Methods

append hasErrors start stop

Events

Constructors

constructor

new ArchiverManager(options?: Partial<ArchiveOptions>): ArchiverManager
Creates a new instance of the ArchiverManager.
Parameters
- Optionaloptions: Partial<ArchiveOptions>
  Service setup options
Returns ArchiverManager

Accessors

stats

get stats(): Record<string, FileStats>
Returns the statistics of the files

Returns Record<string, FileStats>

Methods

append

append(data: Record<string, any> | Record<string, any>[]): Promise<AppendResult>
Appends data to a JSONL file.
Parameters
- data: Record<string, any> | Record<string, any>[]
  Data to append
Returns Promise<AppendResult>
append(
data: Record<string, any> | Record<string, any>[],
filename?: string,
): Promise<AppendResult>
Appends data to a JSONL file.
Parameters
- data: Record<string, any> | Record<string, any>[]
  Data to append
- Optionalfilename: string
  Name of the file to append data to
Returns Promise<AppendResult>

hasErrors

hasErrors(): boolean
Returns the error status of the file handlers

Returns boolean

start

start(): Promise<void>
Starts the ArchiverManager

Returns Promise<void>

stop

stop(): Promise<void>
Stops the jsonl file store manager

Returns Promise<void>

Events

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
on(event: "handlerCleaned", listener: (handlerName: string) => void): this
Adds a listener for the handlerCleaned event, emitted when a handler is cleaned up due to inactivity.
Parameters
- event: "handlerCleaned"
  handlerCleaned event
- listener: (handlerName: string) => void
  Handler cleaned event listener
Returns this