@todesktop/client-ipc

• ToDesktop Client IPC
  • Installation
  • Usage
  • Architecture
  • Development

ToDesktop Client IPC

This is the repo for the ToDesktop IPC client.

This is a zero-dependency package for interacting with @todesktop/plugin-ipc. This package exposes a set of functions for getting metadata about the active window.

Installation

Install @todesktop/client-ipc in your client-side application using

$ npm install @todesktop/client-ipc

Installation of the plugin package is also necessary.

Usage

Get metadata about the active window (title, id, bounds, owner, etc).

import { getActiveWin } from "@todesktop/client-ipc";

(async () => {
  console.log(await getActiveWin(options));
  /*
	{
		bounds: {
			x: 720,
			y: 330,
			height: 600,
			width: 800
		},
		id: 7184,
		memoryUsage: 1248,
		owner: {
			name: 'Simple App',
			processId: 56614,
			bundleId: 'com.google.Chrome',
			path: '/Applications/Google Chrome.app'
		},
		platform: "macos",
		title: 'Google',
	}
	*/
})();

Architecture

This package requires the following files:

• src/index.ts: exposes plugin functionality through strongly-typed, easy-to-use functions.
• src/generated/plugin.d.ts: automatically generated types from @todesktop/plugin-ipc's index.ts file.

Development

Refer to the root repo for development instructions.