www.aleph1.co.uk Git - yaffs-website/blob - node_modules/beeper/readme.md

   1 # beeper [![Build Status](https://travis-ci.org/sindresorhus/beeper.svg?branch=master)](https://travis-ci.org/sindresorhus/beeper)
   2
   3 > Make your terminal beep
   4
   5 ![](https://cloud.githubusercontent.com/assets/170270/5261236/f8471100-7a49-11e4-81af-96cd09a522d9.gif)
   6
   7 Useful as an attention grabber e.g. when an error happens.
   8
   9
  10 ## Install
  11
  12 ```
  13 $ npm install --save beeper
  14 ```
  15
  16
  17 ## Usage
  18
  19 ```js
  20 var beeper = require('beeper');
  21
  22 beeper();
  23 // beep one time
  24
  25 beeper(3);
  26 // beep three times
  27
  28 beeper('****-*-*');
  29 // beep, beep, beep, beep, pause, beep, pause, beep
  30 ```
  31
  32
  33 ## API
  34
  35 It will not beep if stdout is not TTY or if the user supplies the `--no-beep` flag.
  36
  37 ### beeper([count|melody], [callback])
  38
  39 #### count
  40
  41 Type: `number`
  42 Default: `1`
  43
  44 How many times you want it to beep.
  45
  46 #### melody
  47
  48 Type: `string`
  49
  50 Construct your own melody by supplying a string of `*` for beep `-` for pause.
  51
  52
  53 ## License
  54
  55 MIT © [Sindre Sorhus](http://sindresorhus.com)