Interface: DevHelpers

Defined in: windowStateUtils.ts:31

Properties

getConfig

getConfig: () => {
 constants: {
  DEFAULTS: {
   WINDOW: {
    height: 800;
    minHeight: 600;
    minWidth: 800;
    width: 1200;
   }
  }
  FILES: {
   WINDOW_STATE: "window-state.json";
  }
  PATHS: {
   HTML: {
    INDEX: "index.html";
   }
   ICONS: {
    FAVICON: "icons/favicon.ico";
   }
   PRELOAD: "preload.js";
  }
  WEB_PREFERENCES: {
   contextIsolation: true;
   nodeIntegration: false;
   sandbox: true;
  }
 }
 currentState: WindowState;
 settingsPath: string;
};

Defined in: windowStateUtils.ts:32

Returns

{
 constants: {
  DEFAULTS: {
   WINDOW: {
    height: 800;
    minHeight: 600;
    minWidth: 800;
    width: 1200;
   }
  }
  FILES: {
   WINDOW_STATE: "window-state.json";
  }
  PATHS: {
   HTML: {
    INDEX: "index.html";
   }
   ICONS: {
    FAVICON: "icons/favicon.ico";
   }
   PRELOAD: "preload.js";
  }
  WEB_PREFERENCES: {
   contextIsolation: true;
   nodeIntegration: false;
   sandbox: true;
  }
 }
 currentState: WindowState;
 settingsPath: string;
}

constants

constants: {
 DEFAULTS: {
  WINDOW: {
   height: 800;
   minHeight: 600;
   minWidth: 800;
   width: 1200;
  }
 }
 FILES: {
  WINDOW_STATE: "window-state.json";
 }
 PATHS: {
  HTML: {
   INDEX: "index.html";
  }
  ICONS: {
   FAVICON: "icons/favicon.ico";
  }
  PRELOAD: "preload.js";
 }
 WEB_PREFERENCES: {
  contextIsolation: true;
  nodeIntegration: false;
  sandbox: true;
 }
}

constants.DEFAULTS

readonly DEFAULTS: {
  WINDOW: {
     height: 800;
     minHeight: 600;
     minWidth: 800;
     width: 1200;
  };
};

constants.DEFAULTS.WINDOW

readonly WINDOW: {
  height: 800;
  minHeight: 600;
  minWidth: 800;
  width: 1200;
};

constants.DEFAULTS.WINDOW.height

readonly height: 800 = 800;

constants.DEFAULTS.WINDOW.minHeight

readonly minHeight: 600 = 600;

constants.DEFAULTS.WINDOW.minWidth

readonly minWidth: 800 = 800;

constants.DEFAULTS.WINDOW.width

readonly width: 1200 = 1200;

constants.FILES

readonly FILES: {
  WINDOW_STATE: "window-state.json";
};

constants.FILES.WINDOW_STATE

readonly WINDOW_STATE: "window-state.json" = "window-state.json";

constants.PATHS

readonly PATHS: {
  HTML: {
     INDEX: "index.html";
  };
  ICONS: {
     FAVICON: "icons/favicon.ico";
  };
  PRELOAD: "preload.js";
};

constants.PATHS.HTML

readonly HTML: {
  INDEX: "index.html";
};

constants.PATHS.HTML.INDEX

readonly INDEX: "index.html" = "index.html";

constants.PATHS.ICONS

readonly ICONS: {
  FAVICON: "icons/favicon.ico";
};

constants.PATHS.ICONS.FAVICON

readonly FAVICON: "icons/favicon.ico" = "icons/favicon.ico";

constants.PATHS.PRELOAD

readonly PRELOAD: "preload.js" = "preload.js";

constants.WEB_PREFERENCES

readonly WEB_PREFERENCES: {
  contextIsolation: true;
  nodeIntegration: false;
  sandbox: true;
};

constants.WEB_PREFERENCES.contextIsolation

readonly contextIsolation: true = true;

constants.WEB_PREFERENCES.nodeIntegration

readonly nodeIntegration: false = false;

constants.WEB_PREFERENCES.sandbox

readonly sandbox: true = true;

currentState

currentState: WindowState;

settingsPath

settingsPath: string;

---

resetState

resetState: () => boolean;

Defined in: windowStateUtils.ts:37

Returns

boolean

---

validateSettings

validateSettings: () =>
  | {
  error?: undefined;
  exists: boolean;
  isValid: boolean;
  path: string;
  state: WindowState;
}
  | {
  error: string;
  exists: boolean;
  isValid: false;
  path: string;
  state?: undefined;
};

Defined in: windowStateUtils.ts:38

Returns

| { error?: undefined; exists: boolean; isValid: boolean; path: string; state: WindowState; } | { error: string; exists: boolean; isValid: false; path: string; state?: undefined; }