Interface: LogPayload

Represents an individual log entry.

Remarks

When displayed in the editor, the log entry will have the following format:


                             inspect node ┐
  ┌ expand more          duration ┐       │
  ▼                               ▼       ▼
┌────────────────────────────────────────────┐
│ ▶ message                       300 ms (+) │
├────────────────────────────────────────────┤
│ remarks                                    │
│ object                                     │
│ stacktrace                                 │
└────────────────────────────────────────────┘

Indexable

[K: string]: any

Any additional information that the log may contain.

Properties

durationMs?

optional durationMs?: number

Defined in: app/Logger.ts:78

An optional duration in milliseconds.

Remarks

Can be used to display any duration related to the log. The value is always visible next to the message.

inspect?

optional inspect?: string

Defined in: app/Logger.ts:89

An optional key used to inspect a related object.

Remarks

This will be used together with the scenes.Inspectable interface to display additional information about the inspected object. When specified, the log will have an “inspect” button that will open the “Properties” tab and select the inspected object.

level?

optional level?: LogLevel

Defined in: app/Logger.ts:35

The log level.

message

message: string

Defined in: app/Logger.ts:43

The main message of the log.

Remarks

Always visible.

object?

optional object?: any

Defined in: app/Logger.ts:59

An object that will be serialized as JSON and displayed under the message.

Remarks

Visible only when the log is expanded.

remarks?

optional remarks?: string

Defined in: app/Logger.ts:51

Additional information about the log.

Remarks

Visible only when the log is expanded.

stack?

optional stack?: string

Defined in: app/Logger.ts:69

The stack trace of the log.

Remarks

Visible only when the log is expanded. The current stack trace can be obtained using new Error().stack. Both Chromium and Firefox stack traces are supported.