debug

The sos.debug API groups together methods for checking the state of remote debug mode.

Methods

isRemoteDebugEnabled()

The isRemoteDebugEnabled() method returns the state of the Device debug.

isRemoteDebugEnabled(): Promise<boolean>;

onRemoteDebugChanged()

The onRemoteDebugChanged() method sets up a listener, which is called whenever the state of the Device debug is changed.

onRemoteDebugChanged(listener: (data: {
    enabled: boolean;
}) => void): void;

API Example

import { sos } from '@signageos/front-applet';

void sos.onReady(async () => {
	if (await sos.debug.isRemoteDebugEnabled()) {
		console.log('Remote debug is turned on');
	}

	sos.debug.onRemoteDebugChanged((enabled) => {
		console.log('Weinre debug is', { enabled });
	});
});