Inspect and control the displays attached to the system.
const all = hs.screen.all(); // [HSScreen, ...]
const main = hs.screen.main(); // screen containing the focused window
const primary = hs.screen.primary(); // screen with the global menu bar
const right = hs.screen.main().toEast();
if (right) console.log("Screen to the right:", right.name);
const s = hs.screen.primary();
console.log(s.mode);
// → { width: 1440, height: 900, scale: 2, frequency: 60 }
s.setMode(1920, 1080, 1, 60);
const img = await hs.screen.main().snapshot();
img.saveToFile("/tmp/screen.png");
hs.screen.addWatcher(() => {
console.log("Display configuration changed:", hs.screen.all().length, "screens");
});
This module provides the following types:
This module has no properties.
hs.screen.all() -> HSScreen[]const screens = hs.screen.all()
screens.forEach(s => console.log(s.name))hs.screen.main() -> HSScreenconst main = hs.screen.main()
console.log(main && main.name)hs.screen.primary() -> HSScreenconst s = hs.screen.primary()
console.log(s && s.frame)hs.screen.addWatcher(listener) -> None| Name | Type | Description |
|---|---|---|
| listener | function | A function called with no arguments when the display configuration changes. |
hs.screen.addWatcher(() => {
console.log("Screens changed, now: " + hs.screen.all().length)
})hs.screen.removeWatcher(listener) -> None| Name | Type | Description |
|---|---|---|
| listener | function | The function originally passed to `addWatcher`. |
const handler = () => console.log("screens changed")
hs.screen.addWatcher(handler)
hs.screen.removeWatcher(handler)