Skip to content

Commit

Permalink
docs: remove getInfo method
Browse files Browse the repository at this point in the history
  • Loading branch information
sentialx committed Dec 14, 2019
1 parent d2af3c9 commit 6c8cca1
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 25 deletions.
19 changes: 15 additions & 4 deletions docs/breaking-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,6 @@ windowManager.getScaleFactor(windowManager.getActiveWindow().getMonitor());
windowManager.getActiveWindow().getMonitor().getScaleFactor();
```

### `window.getMonitor(): number`

Now the `window.getMonitor` method returns [`Monitor`](monitor.md) object.

### `windowManager.requestAccessibility()` `macOS`

The `windowManager.requestAccessibility` method won't be required before each operation on windows anymore. Only on:
Expand All @@ -27,3 +23,18 @@ The `windowManager.requestAccessibility` method won't be required before each op
- `window.restore`
- `window.bringToTop`
- `window.getTitle`

### `window.getMonitor(): number`

Now the `window.getMonitor` method returns [`Monitor`](monitor.md) object.

### `window.getInfo()`

`window.getInfo` method has been removed.

```typescript
// Deprecated
const { title } = window.getInfo();
// Replace with
const title = window.getTitle();
```
5 changes: 0 additions & 5 deletions docs/monitor-info.md

This file was deleted.

4 changes: 0 additions & 4 deletions docs/monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,6 @@ Gets monitor working area bounds.

- Returns [`Rectangle`](rectangle.md)

#### monitor.getInfo() `Windows`

Returns [`MonitorInfo`](monitor-info.md)

#### monitor.isPrimary() `Windows`

Whether the monitor is primary.
Expand Down
8 changes: 0 additions & 8 deletions docs/window-info.md

This file was deleted.

4 changes: 0 additions & 4 deletions docs/window.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,6 @@ Resizes and moves the window to the supplied bounds. Any properties that are not
window.setBounds({ height: 50 });
```

#### win.getInfo() `Windows` `macOS`

Returns [`WindowInfo`](window-info.md)

#### win.getTitle() `Windows` `macOS`

- Returns `string`
Expand Down

0 comments on commit 6c8cca1

Please sign in to comment.