Class Logger

A concrete implementation of ILogger.

Implements

ILogger

Index

Constructors

Properties

_contentChanged _isDisposed _level _rendermime _stateChanged _version outputAreaModel source

Accessors

contentChanged isDisposed length level maxLength rendermime stateChanged version

Methods

_log checkpoint clear dispose log

Constructors

constructor

new Logger(options): Logger
Construct a Logger.
Parameters
- options: Logger.IOptions
  Constructor options
Returns Logger
- Defined in packages/logconsole/src/logger.ts:198

Properties

`Private` _contentChanged

_contentChanged: Signal<Logger, IContentChange> = ...

`Private` _isDisposed

_isDisposed: boolean = false

`Private` _level

_level: LogLevel = 'warning'

`Private` _rendermime

_rendermime: null | IRenderMimeRegistry = null

`Private` _stateChanged

_stateChanged: Signal<Logger, IStateChange> = ...

`Private` _version

_version: number = 0

`Readonly` outputAreaModel

outputAreaModel: LoggerOutputAreaModel

The output area model used for the logger.

Notes

This will usually not be accessed directly. It is a public attribute so that the renderer can access it.

`Readonly` source

source: string

The source for the logger.

Accessors

contentChanged

get contentChanged(): ISignal<this, IContentChange>
A signal emitted when the list of log messages changes.

Returns ISignal<this, IContentChange>
Implementation of ILogger.contentChanged
- Defined in packages/logconsole/src/logger.ts:254

isDisposed

get isDisposed(): boolean
Whether the logger is disposed.

Returns boolean
Implementation of ILogger.isDisposed
- Defined in packages/logconsole/src/logger.ts:372

length

get length(): number
Number of outputs logged.

Returns number
Implementation of ILogger.length
- Defined in packages/logconsole/src/logger.ts:247

level

get level(): LogLevel
The level of outputs logged

Returns LogLevel
Implementation of ILogger.level
- Defined in packages/logconsole/src/logger.ts:223
set level(newValue): void
Log level.
Parameters
- newValue: LogLevel
Returns void
Implementation of ILogger.level
- Defined in packages/logconsole/src/logger.ts:226

maxLength

get maxLength(): number
The maximum number of outputs stored.

Notes
Oldest entries will be trimmed to ensure the length is at most .maxLength.

Returns number
Implementation of ILogger.maxLength
- Defined in packages/logconsole/src/logger.ts:213
set maxLength(value): void
Max number of messages.
Parameters
- value: number
Returns void
Implementation of ILogger.maxLength
- Defined in packages/logconsole/src/logger.ts:216

rendermime

get rendermime(): null | IRenderMimeRegistry
Rendermime to use when rendering outputs logged.

Returns null | IRenderMimeRegistry
Implementation of ILogger.rendermime
- Defined in packages/logconsole/src/logger.ts:268
set rendermime(value): void
Rendermime to use when rendering outputs logged.
Parameters
- value: null | IRenderMimeRegistry
Returns void
Implementation of ILogger.rendermime
- Defined in packages/logconsole/src/logger.ts:271

stateChanged

get stateChanged(): ISignal<this, IStateChange>
A signal emitted when the log state changes.

Returns ISignal<this, IStateChange>
Implementation of ILogger.stateChanged
- Defined in packages/logconsole/src/logger.ts:261

version

get version(): number
The number of messages that have ever been stored.

Returns number
Implementation of ILogger.version
- Defined in packages/logconsole/src/logger.ts:282

Methods

`Private` _log

_log(options): void
Parameters
- options: {
  level: FullLogLevel;
  output: IOutput;
  }
  - level: FullLogLevel
  - output: IOutput
Returns void
- Defined in packages/logconsole/src/logger.ts:389

checkpoint

checkpoint(): void
Add a checkpoint to the log.

Returns void
Implementation of ILogger.checkpoint
- Defined in packages/logconsole/src/logger.ts:357

clear

clear(): void
Clear all outputs logged.

Returns void
Implementation of ILogger.clear
- Defined in packages/logconsole/src/logger.ts:349

dispose

dispose(): void
Dispose the logger.

Returns void
Implementation of ILogger.dispose
- Defined in packages/logconsole/src/logger.ts:379

log

log(log): void
Log an output to logger.
Parameters
- log: ILogPayload
  The output to be logged.
Returns void
Implementation of ILogger.log
- Defined in packages/logconsole/src/logger.ts:305