diff options
Diffstat (limited to 'vanilla/node_modules/siginfo/README.md')
| -rw-r--r-- | vanilla/node_modules/siginfo/README.md | 47 |
1 files changed, 0 insertions, 47 deletions
diff --git a/vanilla/node_modules/siginfo/README.md b/vanilla/node_modules/siginfo/README.md deleted file mode 100644 index 3552e2a..0000000 --- a/vanilla/node_modules/siginfo/README.md +++ /dev/null @@ -1,47 +0,0 @@ -# `siginfo` - -[](https://travis-ci.org/eemilbayes/siginfo) - -> Utility module to print pretty messages on SIGINFO/SIGUSR1 - -`SIGINFO` on BSD / macOS and `SIGUSR1` on Linux, usually triggered by -`Ctrl + T`, are by convention used to print information about -a long running process internal state. Eg. `dd` will tell you how many blocks it -has written and at what speed, while `xz` will tell you progress, compression -ratio and estimated time remaining. - -This module wraps both signals, checks if the process is connected to TTY and -lets you do whatever you want. - -## Usage - -```js -var siginfo = require('siginfo') -var pkg = require('./package.json') - -siginfo(function () { - console.dir({ - version: pkg.version, - uptime: process.uptime() - }) -}) - -``` - -## API - -### `var removeListener = siginfo(queryFn, [force])` - -`queryFn` can be used for whatever you want (logging, sending a UDP message, etc.). -Setting `force = true` will attach the event handlers whether a TTY is present -or not. - -## Install - -```sh -npm install siginfo -``` - -## License - -[ISC](LICENSE) |