@zturnlibs/ztron-api


window-state

Interfaces

WindowState

Defined in: window-state.ts:7

Properties

alwaysOnTop

alwaysOnTop: boolean

Defined in: window-state.ts:14

fullscreen

fullscreen: boolean

Defined in: window-state.ts:13

height

height: number

Defined in: window-state.ts:11

maximized

maximized: boolean

Defined in: window-state.ts:12

width

width: number

Defined in: window-state.ts:10

x

x: number

Defined in: window-state.ts:8

y

y: number

Defined in: window-state.ts:9


WindowStateOptions

Defined in: window-state.ts:17

Properties

file?

optional file?: string

Defined in: window-state.ts:19

Absolute path of the state JSON file.

Variables

windowState

const windowState: object

Defined in: window-state.ts:47

Type Declaration

get

get: (options) => Promise<WindowState | null> = getWindowState

Reads the persisted window geometry (null when none is saved).

Parameters
options?

WindowStateOptions = {}

Returns

Promise<WindowState | null>

restore

restore: (options) => Promise<WindowState | null> = restoreWindowState

Restores the persisted window geometry (no-op when none is saved).

Parameters
options?

WindowStateOptions = {}

Returns

Promise<WindowState | null>

save

save: (options) => Promise<WindowState> = saveWindowState

Persists the current window geometry and returns what was saved.

Parameters
options?

WindowStateOptions = {}

Returns

Promise<WindowState>

Functions

getWindowState()

getWindowState(options?): Promise<WindowState | null>

Defined in: window-state.ts:23

Reads the persisted window geometry (null when none is saved).

Parameters

options?

WindowStateOptions = {}

Returns

Promise<WindowState | null>


restoreWindowState()

restoreWindowState(options?): Promise<WindowState | null>

Defined in: window-state.ts:39

Restores the persisted window geometry (no-op when none is saved).

Parameters

options?

WindowStateOptions = {}

Returns

Promise<WindowState | null>


saveWindowState()

saveWindowState(options?): Promise<WindowState>

Defined in: window-state.ts:32

Persists the current window geometry and returns what was saved.

Parameters

options?

WindowStateOptions = {}

Returns

Promise<WindowState>