Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ILogger

A Logger that manages logs from a particular source.

Hierarchy

  • IDisposable
    • ILogger

Implemented by

Index

Properties

Readonly contentChanged

contentChanged: ISignal<ILogger, IContentChange>

A signal emitted when the log model changes.

Readonly isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Readonly length

length: number

Number of outputs logged.

level

level: LogLevel

Log level.

maxLength

maxLength: number

Max number of messages.

Readonly outputAreaModel

outputAreaModel: ILoggerOutputAreaModel

Output Area Model used to manage log storage in memory.

rendermime

Rendermime to use when rendering outputs logged.

Readonly source

source: string

The name of the log source.

Readonly stateChanged

stateChanged: ISignal<ILogger, IStateChange>

A signal emitted when the rendermime changes.

Readonly version

version: number

The cumulative number of messages the log has stored.

Methods

checkpoint

  • checkpoint(): void
  • Add a checkpoint in the log.

    Returns void

clear

  • clear(): void
  • Clear all outputs logged.

    Returns void

dispose

  • dispose(): void
  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

log

  • Log an output to logger.

    Parameters

    Returns void

Generated using TypeDoc