interface.Logger
API > Logger
Interface: Logger
An interface for reporting status updates, progress and errors to UI.
Remarks
Loggers report updates to their associated object, e.g. an offline context or an individual offline scene.
Methods
error
error(
message):void
Log an error message.
Parameters
| Parameter | Type |
|---|---|
message | OfflineErrorMessage |
Returns
void
Source
@novorender/offline/logger.ts:24
info
optionalinfo(message):void
Log an informational message, mostly intended for diagnostics.
Parameters
| Parameter | Type |
|---|---|
message | string |
Returns
void
Source
@novorender/offline/logger.ts:18
progress
optionalprogress(value,max,operation):void
Update progress for potentially long running processes, such as synchronization.
Parameters
| Parameter | Type | Description |
|---|---|---|
value | number | The progress as a factor between 0 and max. |
max | undefined | number | The maximum value, or undefined if value is also undefined. |
operation | "scan" | "download" | The operation currently being progressed. |
Returns
void
Source
@novorender/offline/logger.ts:32
status
status(
state):void
Update the current status of object, intended for permanent display.
Parameters
| Parameter | Type | Description |
|---|---|---|
state | string | The new state of object, e.g. "ready", "error" or "completed". |
Returns
void