diff options
Diffstat (limited to 'node_modules/beeper/readme.md')
-rw-r--r-- | node_modules/beeper/readme.md | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/node_modules/beeper/readme.md b/node_modules/beeper/readme.md new file mode 100644 index 000000000..55bdd5298 --- /dev/null +++ b/node_modules/beeper/readme.md @@ -0,0 +1,55 @@ +# beeper [](https://travis-ci.org/sindresorhus/beeper) + +> Make your terminal beep + + + +Useful as an attention grabber e.g. when an error happens. + + +## Install + +``` +$ npm install --save beeper +``` + + +## Usage + +```js +var beeper = require('beeper'); + +beeper(); +// beep one time + +beeper(3); +// beep three times + +beeper('****-*-*'); +// beep, beep, beep, beep, pause, beep, pause, beep +``` + + +## API + +It will not beep if stdout is not TTY or if the user supplies the `--no-beep` flag. + +### beeper([count|melody], [callback]) + +#### count + +Type: `number` +Default: `1` + +How many times you want it to beep. + +#### melody + +Type: `string` + +Construct your own melody by supplying a string of `*` for beep `-` for pause. + + +## License + +MIT © [Sindre Sorhus](http://sindresorhus.com) |