# pgrep

> pgrep api for node.js

Latest version **0.0.6** (published 2015-09-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install pgrep
pnpm add pgrep
yarn add pgrep
bun add pgrep
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2015-09-10 |
| First published | 2015-09-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+4 in 1 direct dependencies) |
| Install scripts | no |
| Author | Travis Webb |
| Maintainers | xtuple |
| Keywords | pgrep, linux, unix, ps, pkill |

## Links

- npm: https://www.npmjs.com/package/pgrep
- Repository: https://github.com/xtuple/node-pgrep
- Issues: https://github.com/xtuple/node-pgrep/issues
- npm.io page: https://npm.io/package/pgrep

## Dependencies (2)

- [lodash](https://npm.io/package/lodash.md) ^2.4.1
- [bluebird](https://npm.io/package/bluebird.md) ^2.3.10

## Recent versions

- 0.0.6 (latest) — 2015-09-10

## README

# node-pgrep

[![NPM version][npm-image]][npm-url]
[![Build status][travis-image]][travis-url]
[![Dependency Status][daviddm-image]][daviddm-url]

## Install
```sh
$ npm install pgrep --save
```

## Usage

```js
var pgrep = require('pgrep');
pgrep.exec({
    euid: 'tjwebb', // owner of process
    full: true,     // whether to match full command line
    parent: 12587   // parent PID
  })
  .then(function (pids) {
    // handle the pids
  });

```

## API

#### `.exec`
Returns [Promise](https://www.npmjs.org/package/bluebird) containing a list of the matching PIDs.

| @param | @description \
|:---|:---|
| `options.euid` | effective user id |
| `options.full` | match the full command line |
| `options.parent` | parent process ID |


#### Manpage
(http://linux.die.net/man/1/pgrep)


## License
MIT

[npm-image]: https://img.shields.io/npm/v/pgrep.svg?style=flat
[npm-url]: https://npmjs.org/package/pgrep
[travis-image]: https://img.shields.io/travis/tjwebb/node-pgrep.svg?style=flat
[travis-url]: https://travis-ci.org/tjwebb/node-pgrep
[daviddm-image]: http://img.shields.io/david/tjwebb/node-pgrep.svg?style=flat
[daviddm-url]: https://david-dm.org/tjwebb/node-pgrep

---
_Source: https://npm.io/package/pgrep · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._