History

Cyryl Płotnicki 2f946d6200 Add .vscode		2016-09-11 10:29:13 +02:00
..
index.js	Add .vscode	2016-09-11 10:29:13 +02:00
license	Add .vscode	2016-09-11 10:29:13 +02:00
package.json	Add .vscode	2016-09-11 10:29:13 +02:00
readme.md	Add .vscode	2016-09-11 10:29:13 +02:00

readme.md

beeper

Make your terminal beep

Useful as an attention grabber e.g. when an error happens.

Install

$ npm install --save beeper

Usage

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.