Events

history.clear

Detailed viewer event reference for history.clear.

Summary

Category: History
Event: history.clear
Trigger: Fires when history is cleared.

Payload

[HistoryChangeEvent];

Payload fields

Payload is not an object literal. Use the declaration above and runtime guards when handling this event.

Subscription example

function onEvent(payload) {
  console.log('history.clear', payload);
}

instance.addEventListener('history.clear', onEvent);
instance.removeEventListener('history.clear', onEvent);