Skip to content

ElectronBrowserWindow.once method

ElectronBrowserWindow › once

Unofficial

Registers a one-time listener for the given window event.

Signature:

once(event: "always-on-top-changed", listener: (event: ElectronEvent, isAlwaysOnTop: boolean) => void): this

Parameters:

ParameterTypeDescription
event"always-on-top-changed"The event name.
listener(event: ElectronEvent, isAlwaysOnTop: boolean) => voidThe event handler.

Returns: thisThis BrowserWindow instance.


Unofficial

Signature:

once(event: "app-command", listener: (event: ElectronEvent, command: string) => void): this

Parameters:

ParameterTypeDescription
event"app-command"
listener(event: ElectronEvent, command: string) => void

Returns: this


Unofficial

Signature:

once(event: "blur", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"blur"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "close", listener: (event: ElectronEvent) => void): this

Parameters:

ParameterTypeDescription
event"close"
listener(event: ElectronEvent) => void

Returns: this


Unofficial

Signature:

once(event: "closed", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"closed"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "enter-full-screen", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"enter-full-screen"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "enter-html-full-screen", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"enter-html-full-screen"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "focus", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"focus"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "hide", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"hide"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "leave-full-screen", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"leave-full-screen"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "leave-html-full-screen", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"leave-html-full-screen"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "maximize", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"maximize"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "minimize", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"minimize"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "move", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"move"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "moved", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"moved"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "new-window-for-tab", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"new-window-for-tab"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "page-title-updated", listener: (event: ElectronEvent, title: string, explicitSet: boolean) => void): this

Parameters:

ParameterTypeDescription
event"page-title-updated"
listener(event: ElectronEvent, title: string, explicitSet: boolean) => void

Returns: this


Unofficial

Signature:

once(event: "ready-to-show", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"ready-to-show"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "resize", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"resize"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "resized", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"resized"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "responsive", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"responsive"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "restore", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"restore"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "rotate-gesture", listener: (event: ElectronEvent, rotation: number) => void): this

Parameters:

ParameterTypeDescription
event"rotate-gesture"
listener(event: ElectronEvent, rotation: number) => void

Returns: this


Unofficial

Signature:

once(event: "scroll-touch-begin", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"scroll-touch-begin"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "scroll-touch-edge", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"scroll-touch-edge"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "scroll-touch-end", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"scroll-touch-end"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "session-end", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"session-end"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "sheet-begin", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"sheet-begin"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "sheet-end", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"sheet-end"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "show", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"show"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "swipe", listener: (event: ElectronEvent, direction: string) => void): this

Parameters:

ParameterTypeDescription
event"swipe"
listener(event: ElectronEvent, direction: string) => void

Returns: this


Unofficial

Signature:

once(event: "system-context-menu", listener: (event: ElectronEvent, point: ElectronPoint) => void): this

Parameters:

ParameterTypeDescription
event"system-context-menu"
listener(event: ElectronEvent, point: ElectronPoint) => void

Returns: this


Unofficial

Signature:

once(event: "unmaximize", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"unmaximize"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "unresponsive", listener: (...args: unknown[]) => void): this

Parameters:

ParameterTypeDescription
event"unresponsive"
listener(...args: unknown[]) => void

Returns: this


Unofficial

Signature:

once(event: "will-move", listener: (event: ElectronEvent, newBounds: ElectronRectangle) => void): this

Parameters:

ParameterTypeDescription
event"will-move"
listener(event: ElectronEvent, newBounds: ElectronRectangle) => void

Returns: this


Unofficial

Signature:

once(event: "will-resize", listener: (event: ElectronEvent, newBounds: ElectronRectangle, details: ElectronWillResizeDetails) => void): this

Parameters:

ParameterTypeDescription
event"will-resize"
listener(event: ElectronEvent, newBounds: ElectronRectangle, details: ElectronWillResizeDetails) => void

Returns: this