Never Pay your Mortgage

    active-win-precompiled
    TypeScript icon, indicating that this package has built-in type declarations

    6.2.1 • Public • Published

    active-win Build Status

    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());
    	/*
    	{
    		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 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….

    Related

    Maintainers

    Install

    npm i active-win-precompiled

    DownloadsWeekly Downloads

    2

    Version

    6.2.1

    License

    MIT

    Unpacked Size

    10.2 MB

    Total Files

    9

    Last publish

    Collaborators

    • nujabes403