https://github.com/zagrios/query-process
Gather information about running processes
https://github.com/zagrios/query-process
cross-platform linux napi-rs nodejs processes rust winapi windows
Last synced: 4 months ago
JSON representation
Gather information about running processes
- Host: GitHub
- URL: https://github.com/zagrios/query-process
- Owner: Zagrios
- License: mit
- Created: 2024-01-09T22:26:53.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-14T01:09:47.000Z (about 2 years ago)
- Last Synced: 2025-02-08T14:03:04.380Z (about 1 year ago)
- Topics: cross-platform, linux, napi-rs, nodejs, processes, rust, winapi, windows
- Language: JavaScript
- Homepage:
- Size: 1.26 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Query-Process
`query-process` is a native Node.js npm library built with NAPI-RS, designed for querying information about external processes. Its initial capability includes checking if a process is running with elevated privileges, with plans for additional features in future updates.
## Installation
```
npm install query-process
```
## Configuration
`query-process` is configured to support multiple platforms, as specified in the `napi` section of `package.json`. This includes various architectures such as Linux, Windows, and Android.
## Usage
After installation, you can require query-process in your Node.js application.
```js
import queryProcess from 'query-process';
```
```js
const queryProcess = require('query-process');
```
# Features
The library currently supports:
- `isElevated`: Synchronously checks if a process is running with elevated privileges.
More features are planned for future releases.
## Examples
### isElevated
```js
import { isElevated } from 'query-process';
try {
const elevated = isElevated(123);
console.log(elevated);
} catch (err) {
console.error(err);
}
```
# Test or Contributing
- Clone this repo
- Install latest stable Rust
- Install Node.js 10+
- Install dependencies with `npm install`
- Build Rust bindings with `npm run build`
- Run `npm test`
## Release package
We use GitHub actions to automatically publish npm packages.
```bash
# 1.0.0 => 1.0.1
npm version patch
# or 1.0.0 => 1.1.0
npm version minor
```
# License
`query-process` is made available under the MIT License. For more information, see the LICENSE file in the repository.