active-win
Get metadata about the active window (title, id, bounds, owner, URL, etc)
Works on macOS, Linux, Windows.
Users on macOS 10.13 or earlier needs to download the Swift runtime support libraries.
Install
$ npm install active-win
Usage
const activeWin = ; async { console; /* { title: 'Unicorns - Google Search', id: 5762, bounds: { x: 0, y: 0, height: 900, width: 1440 }, owner: { name: 'Google Chrome', processId: 310, bundleId: 'com.google.Chrome', path: '/Applications/Google Chrome.app' }, url: 'https://sindresorhus.com/unicorn', memoryUsage: 11015432 } */};
API
activeWin()
Returns a Promise<Object>
with the result, or Promise<undefined>
if there is no active window or if the information is not available.
activeWin.sync()
Returns an Object
with the result, or undefined
if there is no active window.
Result
platform
(string) -'macos'
|'linux'
|'windows'
title
(string) - Window titleid
(number) - Window identifierbounds
(Object) - Window position and sizex
(number)y
(number)width
(number)height
(number)
owner
(Object) - App that owns the windowname
(string) - Name of the appprocessId
(number) - Process identifierbundleId
(string) - Bundle identifier (macOS only)path
(string) - Path to the app
url
(string?) - URL of the active browser tab if the active window is Safari, Chrome, Edge, or Brave (macOS only)memoryUsage
(number) - Memory usage by the window owner process
OS support
It works on macOS, Linux, and Windows 7+.
Note: On Windows, there isn't a clear notion of a "Window ID". Instead it returns the memory address of the window "handle" in the id
property. That "handle" is unique per window, so it can be used to identify them. Read more….
Related
- active-win-cli - CLI for this module
- active-win-log - Window-usage logging CLI using this module