All files / src/controllers DebugController.ts

100% Statements 24/24
100% Branches 0/0
100% Functions 13/13
100% Lines 16/16

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58  5x             5x       7x           7x             7x 1x 1x             7x 1x 1x             7x 1x 1x             7x 1x 1x      
import { EditorAPI } from '../types/CommonTypes';
import { getEditorResponseData } from '../utils/EditorResponseData';
import { DebugData } from '../types/DebugTypes';
 
/**
 * The DebugController is responsible for all communication regarding Debugging.
 * Methods inside this controller can be called by `window.SDK.debug.{method-name}`
 */
export class DebugController {
    /**
     * @ignore
     */
    #editorAPI: EditorAPI;
 
    /**
     * @ignore
     */
    constructor(editorAPI: EditorAPI) {
        this.#editorAPI = editorAPI;
    }
 
    /**
     * This method returns all debug logs
     * @returns list of all debug logs
     */
    getAllLogs = async () => {
        const res = await this.#editorAPI;
        return res.getLogs().then((result) => getEditorResponseData<DebugData[]>(result));
    };
 
    /**
     * This method toggles the showcase of debug panel
     * @returns
     */
    toggleDebugPanel = async () => {
        const res = await this.#editorAPI;
        return res.toggleDebugPanel().then((result) => getEditorResponseData<null>(result));
    };
 
    /**
     * This method enables the debugging
     * @returns
     */
    enableDebug = async () => {
        const res = await this.#editorAPI;
        return res.enableDebug().then((result) => getEditorResponseData<null>(result));
    };
 
    /**
     * This method disables the debugging
     * @returns
     */
    disableDebug = async () => {
        const res = await this.#editorAPI;
        return res.disableDebug().then((result) => getEditorResponseData<null>(result));
    };
}