@novorender/api / Logger

Interface: Logger

Defined in: @novorender/src/offline/logger.ts:6

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;

Defined in: @novorender/src/offline/logger.ts:23

Log an error message.

Parameters

Parameter	Type
message	OfflineErrorMessage

Returns

void

---

info()?

optional info(message): void;

Defined in: @novorender/src/offline/logger.ts:17

Log an informational message, mostly intended for diagnostics.

Parameters

Parameter	Type
message	string

Returns

void

---

progress()?

optional progress(
   value, 
   max, 
   operation): void;

Defined in: @novorender/src/offline/logger.ts:31

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	"download" | "scan"	The operation currently being progressed.

Returns

void

---

status()

status(state): void;

Defined in: @novorender/src/offline/logger.ts:11

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