https://github.com/thlorenz/window-tracker

window tracker
https://github.com/thlorenz/window-tracker

Last synced: 15 days ago
JSON representation

window tracker

• Host: GitHub
• URL: https://github.com/thlorenz/window-tracker
• Owner: thlorenz
• License: mit
• Created: 2017-01-20T02:39:00.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-01-22T18:15:04.000Z (almost 8 years ago)
• Last Synced: 2024-10-18T05:26:15.399Z (19 days ago)
• Language: JavaScript
• Homepage:
• Size: 2.32 MB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# window tracker

Currently only works on OSX _but could be extended to work on Linux and Windows_ **submit those PRs** ;)

## Installation

    npm install window-tracker

![demo](assets/window-tracker.gif)

## Try it

```

cd node_modules/window-tracker && npm test

```

## API

### One time Query Interface

#### `windowTracker.query(cb)`

```js

// not using any filters here, so we'll see all windows output

const windowTracker = require('window-tracker')()

windowTracker.query(onresult)

function onresult(err, infos) {

  if (err) return console.error(err)

  console.log(infos)

}

```

```js

// abbreviated result

[ { app: 'TextEdit',

    appid: 93818,

    window: 'Untitled',

    windowid: 36182,

    bounds: { x: 364, y: 23, w: 842, h: 943 } ]

```

### Tracking Interface

#### `windowTracker.start()`

Make sure to subscribe to `error` and `info` when using the tracking interface.

```js

const { inspect } = require('util')

const getWindowTracker = require('window-tracker')

// appFilter and windowFilter can be a predicate or a RegExp

const appFilter = /MacVim/i

const windowFilter = /window-tracker/i

const windowTracker = getWindowTracker({ interval: 1000, appFilter, windowFilter })

  .on('error', console.error)

  .on('info', oninfo)

  .start()

let count = 0

function oninfo(info) {

  console.log(inspect(info, false, 5, true))

  if (++count > 20) windowTracker.stop()

}

```

## License

MIT