@todesktop/client-active-win
Advanced tools
Comparing version 0.14.0 to 0.15.0
{ | ||
"name": "@todesktop/client-active-win", | ||
"version": "0.14.0", | ||
"version": "0.15.0", | ||
"description": "", | ||
@@ -5,0 +5,0 @@ "main": "dist/index.js", |
@@ -1,14 +0,5 @@ | ||
- [ToDesktop Client Active Win](#todesktop-client-active-win) | ||
- [Installation](#installation) | ||
- [Usage](#usage) | ||
- [Architecture](#architecture) | ||
- [Development](#development) | ||
# ToDesktop Active Win | ||
# ToDesktop Client Active Win | ||
Get metadata about the active window. | ||
This is the repo for the [ToDesktop Active Win](https://github.com/ToDesktop/todesktop-active-win) client. | ||
This is a zero-dependency package for interacting with [@todesktop/plugin-active-win](https://www.npmjs.com/package/@todesktop/plugin-active-win). This package exposes a set of functions for getting metadata about the active window. | ||
## Installation | ||
@@ -19,9 +10,11 @@ | ||
```sh | ||
$ npm install @todesktop/client-active-win | ||
npm install @todesktop/client-active-win | ||
``` | ||
Installation of the [plugin](https://www.npmjs.com/package/@todesktop/plugin-active-win) package is also necessary. | ||
Installation of the [plugin](https://www.npmjs.com/package/@todesktop/plugin-active-win) package is also necessary. Using ToDesktop Builder, navigate to **Plugins.** Click on the **Explore** button for "Active Window" and install the package. | ||
## Usage | ||
### `getActiveWin` | ||
Get metadata about the active window (title, id, bounds, owner, etc). | ||
@@ -56,12 +49,1 @@ | ||
``` | ||
## 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-active-win`'s `index.ts` file. | ||
## Development | ||
Refer to the [root](https://github.com/ToDesktop/todesktop-active-win) repo for development instructions. |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
3914
48