Interface ILogger

A Logger that manages logs from a particular source.

interface ILogger {
    contentChanged: ISignal<ILogger, IContentChange>;
    isDisposed: boolean;
    length: number;
    level: LogLevel;
    maxLength: number;
    outputAreaModel: ILoggerOutputAreaModel;
    rendermime: null | IRenderMimeRegistry;
    source: string;
    stateChanged: ISignal<ILogger, IStateChange>;
    version: number;
    checkpoint(): void;
    clear(): void;
    dispose(): void;
    log(log: ILogPayload): void;
}

Hierarchy

Implemented by

Properties

contentChanged isDisposed length level maxLength outputAreaModel rendermime source stateChanged version

Methods

checkpoint clear dispose log

Properties

ReadonlycontentChanged

contentChanged: ISignal<ILogger, IContentChange>

A signal emitted when the log model changes.

ReadonlyisDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Readonlylength

length: number

Number of outputs logged.

level

level: LogLevel

Log level.

maxLength

maxLength: number

Max number of messages.

ReadonlyoutputAreaModel

outputAreaModel: ILoggerOutputAreaModel

Output Area Model used to manage log storage in memory.

rendermime

rendermime: null | IRenderMimeRegistry

Rendermime to use when rendering outputs logged.

Readonlysource

source: string

The name of the log source.

ReadonlystateChanged

stateChanged: ISignal<ILogger, IStateChange>

A signal emitted when the rendermime changes.

Readonlyversion

version: number

The cumulative number of messages the log has stored.

Methods

checkpoint

clear

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

Settings

Member Visibility

On This Page

Properties
Methods