ElectronScreen.once method

ElectronScreen › once

Unofficial

Registers a one-time listener for the display-added event. The listener is removed after it is invoked once.

Signature:

once(event: "display-added", listener: (event: ElectronEvent, newDisplay: ElectronDisplay) => void): this

Parameters:

Parameter	Type	Description
event	"display-added"	The event name.
listener	(event: ElectronEvent, newDisplay: ElectronDisplay) => void	The event handler.

Returns: this — This ElectronScreen instance.

---

Unofficial

Registers a one-time listener for the display-metrics-changed event. The listener is removed after it is invoked once.

Signature:

once(event: "display-metrics-changed", listener: (event: ElectronEvent, display: ElectronDisplay, changedMetrics: string[]) => void): this

Parameters:

Parameter	Type	Description
event	"display-metrics-changed"	The event name.
listener	(event: ElectronEvent, display: ElectronDisplay, changedMetrics: string[]) => void	The event handler.

Returns: this — This ElectronScreen instance.

---

Unofficial

Registers a one-time listener for the display-removed event. The listener is removed after it is invoked once.

Signature:

once(event: "display-removed", listener: (event: ElectronEvent, oldDisplay: ElectronDisplay) => void): this

Parameters:

Parameter	Type	Description
event	"display-removed"	The event name.
listener	(event: ElectronEvent, oldDisplay: ElectronDisplay) => void	The event handler.

Returns: this — This ElectronScreen instance.

---