window-info v1.0.4

window-info

window-info is a readable stream that pushes data about windows on screen on MacOS.

It opens a Python process which uses Quartz library to get information about windows.

yarn add -E window-info

Table of Contents

• Table of Contents
• API
  • WindowInfo Stream
    • constructor(delay?: number = 1000): WindowInfo
    • destroy(): void
  • Data Type
    • winid
    • App Name
    • Window Title
    • pid

API

The default exported class is WindowInfo which is a Readable stream.

import WindowInfo from 'window-info'

WindowInfo Stream

WindowInfo is a Readable stream open in object mode with high watermark set to 0 to prevent caching of window data when receiving streams haven't processed previous data. This ensures that the newer data is always as fresh as possible. The presence of the delay value ensures that no data is written before the delay has passed since last write.

constructor(  delay?: number = 1000,): WindowInfo

Create a new stream. The delay argument controls how often to query data.

import { Transform } from 'stream'
import WindowInfo from 'window-info'

(async () => {
  const wi = new WindowInfo({
    delay: 1000,
  })
  let receivedData = 0
  const limit = 1
  wi
    .pipe(new Transform({
      transform(data, enc, next) {
        if (receivedData < limit) {
          this.push(data)
        } else {
          // limit reached
          wi.destroy()
        }
        receivedData++
        next()
      },
      objectMode: true,
      highWaterMark: 0, // disable receiving buffering
    }))
    .pipe(new Transform({
      transform(data, enc, next) {
        this.push(JSON.stringify([
          ['winid', 'App Name', 'Window Title', 'pid'],
          ...data,
        ]))
        next()
      },
      writableObjectMode: true,
    }))
    .pipe(process.stdout)
})()

destroy(): void

Call the destroy method to kill the underlying python process and end the stream.

Data Type

Each data row in the read chunk contains information about open windows in form of an array.

For example, WindowInfo can generate the following:

[
  [480, "Code", "example.js — window-info", 405],
  [89, "Google Chrome", "Stream | Node.js v10.2.1 Documentation", 410]
]

The type definition then is according to the position in the array.

(c) Art Deco 2018