Skip to content

Commit 9718f19

Browse files
committed
docs: document monitors api
1 parent 83efba5 commit 9718f19

File tree

2 files changed

+51
-8
lines changed

2 files changed

+51
-8
lines changed

README.md

Lines changed: 50 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,18 @@ window.setBounds({ x: 0, y: 0 });
5959

6060
- Returns [`Window`](#class-window)
6161

62-
#### windowManager.getScaleFactor(monitor: number) `Windows`
63-
64-
- Returns `number` - the monitor scale factor.
65-
6662
#### windowManager.getWindows() `Windows` `macOS`
6763

6864
- Returns [`Window[]`](#class-window)
6965

66+
#### windowManager.getMonitors() `Windows`
67+
68+
- Returns [`Monitor[]`](#class-monitor)
69+
70+
#### windowManager.getPrimaryMonitor() `Windows`
71+
72+
- Returns [`Monitor`](#class-monitor)
73+
7074
### Events
7175

7276
#### Event 'window-activated' `Windows` `macOS`
@@ -151,9 +155,9 @@ Returns `number` between 0 and 1.
151155

152156
#### win.getMonitor() `Windows`
153157

154-
Gets monitor by window.
158+
Gets monitor which the window belongs to.
155159

156-
Returns `number` - monitor handle.
160+
Returns [`Monitor`](#class-monitor)
157161

158162
#### win.isWindow() `Windows` `macOS`
159163

@@ -175,4 +179,43 @@ Returns [`Window`](#class-window)
175179

176180
- `size` number - can be only `16`, `32`, `64`, `256`. By default it's `64`.
177181

178-
Returns a png Buffer
182+
Returns a png Buffer
183+
184+
185+
## Class `Monitor` `Windows`
186+
187+
### new Monitor(id: number)
188+
189+
- `id` number - the monitor handle
190+
191+
### Instance properties
192+
193+
- `id` number
194+
195+
### Instance methods
196+
197+
#### monitor.getBounds() `Windows`
198+
199+
- Returns [`Rectangle`](#object-rectangle)
200+
201+
#### monitor.getWorkArea() `Windows`
202+
203+
Gets monitor working area bounds.
204+
205+
- Returns [`Rectangle`](#object-rectangle)
206+
207+
#### monitor.getInfo() `Windows`
208+
209+
Returns [`MonitorInfo`](#object-monitorinfo)
210+
211+
#### monitor.isPrimary() `Windows`
212+
213+
Whether the monitor is primary.
214+
215+
- Returns `boolean`
216+
217+
#### monitor.getScaleFactor() `Windows`
218+
219+
Gets monitor scale factor (DPI).
220+
221+
- Returns `number`

src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ class WindowManager extends EventEmitter {
7272
return addon.getMonitors().map((mon: any) => new Monitor(mon));
7373
};
7474

75-
getPrimaryWindow = (): Monitor => {
75+
getPrimaryMonitor = (): Monitor => {
7676
return this.getMonitors().find(x => x.isPrimary);
7777
}
7878
}

0 commit comments

Comments
 (0)