Interface ZLogBufferSpec

A specification of how to buffer log messages.

Hierarchy

  • ZLogBufferSpec

Properties

atMost?

Methods

onRecord?

Properties

Optional Readonly atMost

atMost?: number

Buffer limit. I.e. the maximum number of log messages to store in buffer.

The values less that 1 are treated as 1.

Default

1024

Methods

Optional onRecord

  • This is called whenever a log message is about to be buffered.

    It may drop either the new message, or some of already buffered ones.

    If the buffer is full (i.e. its fill ratio is 1), and this method did not drop any of the messages, then the oldest message will be dropped.

    Parameters

    • newEntry: Entry

      Log message entry about to be buffered.

    • contents: Contents

      Current contents of the log buffer.

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc