Skip to content

Commit 5d13a66

Browse files
committed
Document window order
Fixes #163
1 parent 02ffe29 commit 5d13a66

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

index.d.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,11 +143,15 @@ declare const activeWindow: {
143143

144144
/**
145145
Get metadata about all open windows.
146+
147+
Windows are returned in order from front to back.
146148
*/
147149
getOpenWindows(options?: activeWindow.Options): Promise<activeWindow.Result[]>;
148150

149151
/**
150152
Get metadata about all open windows synchronously.
153+
154+
Windows are returned in order from front to back.
151155
*/
152156
getOpenWindowsSync(options?: activeWindow.Options): activeWindow.Result[];
153157
};

readme.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,12 +86,16 @@ Returns a `Promise<object>` with the result, or `Promise<undefined>` if there is
8686

8787
Get metadata about all open windows.
8888

89+
Windows are returned in order from front to back.
90+
8991
Returns `Promise<activeWindow.Result[]>`.
9092

9193
### activeWindow.getOpenWindowsSync()
9294

9395
Get metadata about all open windows synchronously.
9496

97+
Windows are returned in order from front to back.
98+
9599
Returns `activeWindow.Result[]`.
96100

97101
## OS support

0 commit comments

Comments
 (0)