@miniben90/x-win 1.5.0 → 1.6.0

package/README.md

@@ -16,7 +16,7 @@ npm i @miniben90/x-win
 yarn add @miniben90/x-win
 ```
 
-## How to use
+## How to use x-win
 
 ### Get information about the currently active window
 
@@ -56,6 +56,18 @@ console.log(currentWindow);
 }
 ```
 
+You can also use asynchronous methods instead. To do so, you just have to use `activeWindowAsync`, for example:
+
+```typescript
+import { activeWindowAsync, type WindowInfo } from '@miniben90/x-win';
+
+activeWindow()
+.then((currentWindow: WindowInfo) => {
+  console.log(currentWindow);
+});
+
+```
+
 ### Get a list of open windows with information
 
 `exemple.ts`:
@@ -94,6 +106,18 @@ console.log(windows);
 }]
 ```
 
+You can also use asynchronous methods instead. To do so, you just have to use `openWindowsAsync`, for example:
+
+```typescript
+import { openWindowsAsync, type WindowInfo } from '@miniben90/x-win';
+
+openWindowsAsync()
+.then((windows: WindowInfo[]) => {
+  console.log(windows);
+});
+
+```
+
 ### Subscribe to get the current active window
 
 Thread will be start to check every `100ms` for a new active window (checking window title, window id and process id).

package/index.d.ts

@@ -39,8 +39,130 @@ export interface WindowInfo {
   usage: UsageInfo
   url: string
 }
+/**
+ * Retrieve information the about currently active window.
+ * Returns an object of `WindowInfo`.
+ *
+ * # Example
+ * ```javascript
+ * const currentWindow = activeWindow();
+ * console.log(currentWindow);
+ * ```
+ *
+ * # Information about Electron
+ *
+ * It is recommended to use this function within a worker to mitigate potential recovery issues on MacOS.
+*/
 export function activeWindow(): WindowInfo
+/**
+ * Retrieve information about the currently active window as a promise.
+ * Returns an object of `WindowInfo`.
+ *
+ * # Example
+ * ```javascript
+ * activeWindow()
+ * .then(currentWindow => {
+ *   console.log(currentWindow);
+ * });
+ * ```
+ *
+ * # Information about Electron
+ *
+ * It is recommended to use this function within a worker to mitigate potential recovery issues on MacOS.
+*/
+export function activeWindowAsync(): Promise<WindowInfo>
+/**
+ * Retrieve information about the currently open windows.
+ * Returns an array of `WindowInfo`, each containing details about a specific open window.
+ *
+ * # Example
+ * ```javascript
+ * const windows = openWindows();
+ * for (let i = 0; i < windows.length; i++) {
+ *   console.log(i, windows[i]);
+ * }
+ * ```
+ *
+ * # Information about Electron
+ *
+ * It is recommended to use this function within a worker to mitigate potential recovery issues on MacOS.
+*/
 export function openWindows(): Array<WindowInfo>
+/**
+ * Retrieve information about the currently open windows as a promise.
+ * Returns an array of `WindowInfo`, each containing details about a specific open window.
+ *
+ * # Example
+ * ```javascript
+ * openWindows()
+ * .then(windows => {
+ *   for (let i = 0; i < windows.length; i++) {
+ *     console.log(i, windows[i]);
+ *   }
+ * });
+ * ```
+ *
+ * # Information about Electron
+ *
+ * It is recommended to use this function within a worker to mitigate potential recovery issues on MacOS.
+*/
+export function openWindowsAsync(): Promise<Array<WindowInfo>>
+/**
+ * Subscribe an observer thread to monitor changes in the active window.
+ *
+ * # Example
+ * ```javascript
+ * const a = subscribeActiveWindow((info) => {
+ *   t.log(a, info);
+ * });
+ * const b = subscribeActiveWindow((info) => {
+ *   t.log(b, info);
+ * });
+ * const c = subscribeActiveWindow((info) => {
+ *   t.log(c, info);
+ * });
+ *
+ * unsubscribeAllActiveWindow();
+ * ```
+*/
 export function subscribeActiveWindow(callback: (info: WindowInfo) => void): number
+/**
+ * Terminate and unsubscribe a specific observer using their ID.
+ *
+ * # Example
+ * ```javascript
+ * const a = subscribeActiveWindow((info) => {
+ *   t.log(a, info);
+ * });
+ * const b = subscribeActiveWindow((info) => {
+ *   t.log(b, info);
+ * });
+ * const c = subscribeActiveWindow((info) => {
+ *   t.log(c, info);
+ * });
+ *
+ * unsubscribeActiveWindow(a);
+ * unsubscribeActiveWindow(b);
+ * unsubscribeActiveWindow(c);
+ * ```
+*/
 export function unsubscribeActiveWindow(threadId: number): void
+/**
+ * Terminate and unsubscribe all observer threads monitoring changes in the active window.
+ *
+ * # Example
+ * ```javascript
+ * const a = subscribeActiveWindow((info) => {
+ *   t.log(a, info);
+ * });
+ * const b = subscribeActiveWindow((info) => {
+ *   t.log(b, info);
+ * });
+ * const c = subscribeActiveWindow((info) => {
+ *   t.log(c, info);
+ * });
+ *
+ * unsubscribeAllActiveWindow();
+ * ```
+*/
 export function unsubscribeAllActiveWindow(): void

package/index.js

@@ -281,10 +281,12 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { activeWindow, openWindows, subscribeActiveWindow, unsubscribeActiveWindow, unsubscribeAllActiveWindow } = nativeBinding
+const { activeWindow, activeWindowAsync, openWindows, openWindowsAsync, subscribeActiveWindow, unsubscribeActiveWindow, unsubscribeAllActiveWindow } = nativeBinding
 
 module.exports.activeWindow = activeWindow
+module.exports.activeWindowAsync = activeWindowAsync
 module.exports.openWindows = openWindows
+module.exports.openWindowsAsync = openWindowsAsync
 module.exports.subscribeActiveWindow = subscribeActiveWindow
 module.exports.unsubscribeActiveWindow = unsubscribeActiveWindow
 module.exports.unsubscribeAllActiveWindow = unsubscribeAllActiveWindow

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@miniben90/x-win",
   "description": "This package allows you to retrieve precise information about active and open windows on Windows, MacOS, and Linux. You can obtain the position, size, title, and other memory of windows.",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "main": "index.js",
   "types": "index.d.ts",
   "files": [
@@ -61,12 +61,12 @@
   },
   "packageManager": "yarn@4.0.2",
   "optionalDependencies": {
-    "@miniben90/x-win-win32-x64-msvc": "1.5.0",
-    "@miniben90/x-win-darwin-x64": "1.5.0",
-    "@miniben90/x-win-linux-x64-gnu": "1.5.0",
-    "@miniben90/x-win-darwin-arm64": "1.5.0",
-    "@miniben90/x-win-win32-arm64-msvc": "1.5.0",
-    "@miniben90/x-win-win32-ia32-msvc": "1.5.0",
-    "@miniben90/x-win-darwin-universal": "1.5.0"
+    "@miniben90/x-win-win32-x64-msvc": "1.6.0",
+    "@miniben90/x-win-darwin-x64": "1.6.0",
+    "@miniben90/x-win-linux-x64-gnu": "1.6.0",
+    "@miniben90/x-win-darwin-arm64": "1.6.0",
+    "@miniben90/x-win-win32-arm64-msvc": "1.6.0",
+    "@miniben90/x-win-win32-ia32-msvc": "1.6.0",
+    "@miniben90/x-win-darwin-universal": "1.6.0"
   }
 }