-
Notifications
You must be signed in to change notification settings - Fork 67
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #40 from ffflorian/fix/types
fix(types): Comments and default function name
- Loading branch information
Showing
1 changed file
with
38 additions
and
61 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,67 +1,44 @@ | ||
| import Electron from 'electron' | ||
|
|
||
| export type Options = Partial<{ | ||
| defaultWidth: number | ||
|
|
||
| // The width that should be returned if no file exists yet. Defaults to 800. | ||
|
|
||
| defaultHeight: number | ||
|
|
||
| // The height that should be returned if no file exists yet. Defaults to 600. | ||
|
|
||
| path: string | ||
|
|
||
| // The path where the state file should be written to. Defaults to app.getPath('userData') | ||
|
|
||
| file: string | ||
|
|
||
| // The name of file. Defaults to window-state.json | ||
|
|
||
| maximize: boolean | ||
|
|
||
| // Should we automatically maximize the window, if it was last closed maximized. Defaults to true | ||
|
|
||
| fullScreen: boolean | ||
| }> | ||
|
|
||
| export type State = { | ||
| x: number | ||
|
|
||
| // The saved x coordinate of the loaded state. undefined if the state has not been saved yet. | ||
|
|
||
| y: number | ||
|
|
||
| // The saved y coordinate of the loaded state. undefined if the state has not been saved yet. | ||
|
|
||
| width: number | ||
|
|
||
| // The saved width of loaded state. defaultWidth if the state has not been saved yet. | ||
|
|
||
| height: number | ||
|
|
||
| // The saved heigth of loaded state. defaultHeight if the state has not been saved yet. | ||
|
|
||
| isMaximized: boolean | ||
|
|
||
| // true if the window state was saved while the window was maximized. undefined if the state has not been saved yet. | ||
|
|
||
| isFullScreen: boolean | ||
|
|
||
| // true if the window state was saved while the window was in full screen mode. undefined if the state has not been saved yet. | ||
|
|
||
| manage: (window: Electron.BrowserWindow) => void | ||
|
|
||
| // Register listeners on the given BrowserWindow for events that are related to size or position changes (resize, move). It will also restore the window's maximized or full screen state. When the window is closed we automatically remove the listeners and save the state. | ||
|
|
||
| unmanage: () => void | ||
|
|
||
| // Removes all listeners of the managed BrowserWindow in case it does not need to be managed anymore. | ||
|
|
||
| saveState: (window: Electron.BrowserWindow) => void | ||
| export interface Options { | ||
| /** The height that should be returned if no file exists yet. Defaults to `600`. */ | ||
| defaultHeight?: number; | ||
| /** The width that should be returned if no file exists yet. Defaults to `800`. */ | ||
| defaultWidth?: number; | ||
| fullScreen?: boolean; | ||
| /** The path where the state file should be written to. Defaults to `app.getPath('userData')`. */ | ||
| path?: string; | ||
| /** The name of file. Defaults to `window-state.json`. */ | ||
| file?: string; | ||
| /** Should we automatically maximize the window, if it was last closed maximized. Defaults to `true`. */ | ||
| maximize?: boolean; | ||
| } | ||
|
|
||
| // Saves the current state of the given BrowserWindow. This exists mostly for legacy purposes, and in most cases it's better to just use manage. | ||
| export interface State { | ||
| displayBounds: { | ||
| height: number; | ||
| width: number; | ||
| }; | ||
| /** The saved height of loaded state. `defaultHeight` if the state has not been saved yet. */ | ||
| height: number; | ||
| /** true if the window state was saved while the window was in full screen mode. `undefined` if the state has not been saved yet. */ | ||
| isFullScreen: boolean; | ||
| /** `true` if the window state was saved while the window was maximized. `undefined` if the state has not been saved yet. */ | ||
| isMaximized: boolean; | ||
| /** Register listeners on the given `BrowserWindow` for events that are related to size or position changes (resize, move). It will also restore the window's maximized or full screen state. When the window is closed we automatically remove the listeners and save the state. */ | ||
| manage: (window: Electron.BrowserWindow) => void; | ||
| /** Saves the current state of the given `BrowserWindow`. This exists mostly for legacy purposes, and in most cases it's better to just use `manage()`. */ | ||
| saveState: (window: Electron.BrowserWindow) => void; | ||
| /** Removes all listeners of the managed `BrowserWindow` in case it does not need to be managed anymore. */ | ||
| unmanage: () => void; | ||
| /** The saved width of loaded state. `defaultWidth` if the state has not been saved yet. */ | ||
| width: number; | ||
| /** The saved x coordinate of the loaded state. `undefined` if the state has not been saved yet. */ | ||
| x: number; | ||
| /** The saved y coordinate of the loaded state. `undefined` if the state has not been saved yet. */ | ||
| y: number; | ||
| } | ||
|
|
||
| declare function module(opts: Options): State | ||
| declare function windowStateKeeper(opts: Options): State; | ||
|
|
||
| export default module | ||
| export default windowStateKeeper; |