JSPM

@rize-io/active-win

6.3.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 87
  • Score
    100M100P100Q72388F
  • License MIT

Get metadata about the active window (title, id, bounds, owner, URL, etc). Works on macOS, Linux, Windows.

Package Exports

  • @rize-io/active-win

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@rize-io/active-win) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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 = require('active-win');

(async () => {
    console.log(await activeWin(options));
    /*
    {
        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(options?)

options

Type: object

screenRecordingPermission

Type: boolean
Default: true

Enable the screen recording permission check (macOS). Setting this to false will prevent the Screen Recording permission prompt on macOS versions 10.15 and newer. The title property in the result will always be set to an empty string.

activeWin.sync(options?)

options

Type: object

screenRecordingPermission

Type: boolean
Default: true

Enable the screen recording permission check (macOS). Setting this to false will prevent the Screen Recording permission prompt on macOS versions 10.15 and newer. The title property in the result will always be set to an empty string.

Result

Returns a Promise<Object> with the result, or Promise<undefined> if there is no active window or if the information is not available.

  • platform (string) - 'macos' | 'linux' | 'windows'
  • title (string) - Window title
  • id (number) - Window identifier
  • bounds (Object) - Window position and size
    • x (number)
    • y (number)
    • width (number)
    • height (number)
  • owner (Object) - App that owns the window
    • name (string) - Name of the app
    • processId (number) - Process identifier
    • bundleId (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….

Maintainers