Interface ZLogBuffer

Log buffer.

A log recorder that buffers messages and is able to drain them to another recorder.

The buffered messages are not

Hierarchy

ZLogRecorder
- ZLogBuffer

Index

Methods

drainTo end record whenLogged

Methods

drainTo

drainTo(target, atOnce?): void
Drains buffered messages to target log recorder.

Messages are drained one at a time. The next message is recorded to target only when the previous one either logged or discarded.

Calling this method again changes the target.
Parameters
- target: undefined | null | ZLogRecorder
  
  Target log recorder to drain buffered messages to, or null/undefined to stop draining.
- Optional atOnce: number
  
  The maximum number of buffered messages to drain at once. 32 by default.
Returns void
- Defined in run-z/log-z/src/logs/log-buffer.ts:24

end

end(): Promise<void>
Ends log recording.

All messages discarded after this method call.

Returns Promise<void>
A promise resolved when recorder stopped.
Inherited from ZLogRecorder.end
- Defined in run-z/log-z/src/log-recorder.ts:35

record

record(message): void
Records a log message.

The actual logging of the message can be asynchronous.
Parameters
- message: ZLogMessage
  
  A message to record.
Returns void
Inherited from ZLogRecorder.record
- Defined in run-z/log-z/src/log-recorder.ts:16

whenLogged

whenLogged(which?): Promise<boolean>
Awaits for the recorded message(s) to be either logged or discarded.
Parameters
- Optional which: "all" | "last"
  
  Which message to wait for. Either "all" to wait for all messages or "last" to wait for the last message only. The default is "last"
Returns Promise<boolean>
A promise resolved to true if the last recorded message is logged, or to false if it is discarded.
Inherited from ZLogRecorder.whenLogged
- Defined in run-z/log-z/src/log-recorder.ts:26

Generated using TypeDoc